VeloDB Manager 23.x Installation Manual

VeloDB Manager is a tool introduced by VeloDB for managing and operating Apache Doris and VeloDB Enterprise clusters. You can follow the instructions below to download and deploy VeloDB Manager.

Installation package download and instructions

Download link

https://www.velodb.com/download/enterprise (opens in a new tab)

Installation package instructions

1. Installation package name
   1. velodb-manager-23.11.0-x64-bin.tar.gz
2. Unzip the installation package

$ tar -zxvf velodb-manager-23.11.0-x64-bin.tar.gz

3. Installation package directory structure

velodb-manager-23.11.0-x64-bin
    webserver // VeloDB Manager web service component, which is a web portal service that needs to be manually started
       bin  // start/stop script
       conf  // configuration file
       lib  // service binary
       static  // frontend static files
       config-tool  // VeloDB Manager service management tool
       inspection  // inspection script
    dorisctrl // VeloDB Manager manager control component
       bin  // start/stop script
       conf // configuration file
       lib  // service binary
    deps // VeloDB Manager manager control dependency component
       alertmanager // alert tool
       jdk // jdk dependency package
       prometheus // monitor metrics storage tool
       grafana // monitor dashboard tool
       VeloDB-Enterprise-Overview.json // default dashboard json file, the name is based on the actual

Manual deployment of VeloDB Manager web service component

1. Enter the webserver path of the installation package
2. Configure the Web service (optional)

Read the conf/manager.conf file located in the webserver path

# VeloDB Manager Web server port that the service component is listening on
MANAGER_PORT=8004

# Service-dependent database type: MySQL, h2, or PostgreSQL. Default is h2
DB_TYPE=h2

# If the database type is h2, the default data storage path is the data path under the webserver directory.
# Users can also specify a custom absolute path.
DATA_PATH=

# If the database type is MySQL, configure the access address of the MySQL
DB_HOST=

# Configure access port of the MySQL/PostgreSQ
DB_PORT=

# Configure access users for MySQL/PostgreSQL
DB_USER=

# Configure user passwords for accessing MySQL/PostgreSQL 
DB_PASS=

# Configure access database name of MySQL/PostgreSQL 
DB_DBNAME=

3. Start web service

Run the script directly in the webserver directory :

$ sh bin/start.sh

4. Access web services

Directly enter the URL in the browser - http://{Web service machine IP}: {Web server port}, for example http://172.20.17.107:8004 (opens in a new tab)

Automated deployment of dependent service components via web service

1. Initialize VeloDB Manager administrator account

When accessing the web service for the first time, enter the initialization user page to create the initial VeloDB Manager administrator account.

2. Configure service component deployment information

After creating the VeloDB Manager user, click Next to enter the service component configuration page and fill in the configuration information.

3. Deploy Service Components

Click Start VeloDB Manager will display a message on the page indicating that VeloDB Manager is starting.

After successful startup, it will prompt the user to Enter VeloDB Manager :

Upgrade VeloDB Manager

The administrator account of VeloDB Manager can directly view the current version of the service through the web page, and click upgrade directly through the page. The detailed method is as follows:

1. View the current service version

Click on the user information in the lower left corner of the page to view the current version of the service.

2. Download the new version of VeloDB Manager installation package

Click on the version information in step 1 to prompt the storage path of the target version installation package on the VeloDB Manager server.

Directly log in to the VeloDB Manager server machine and save the new version of the installation package into the directory. Then refresh the page to view and select the target version.

Click the Upgrade button to enter the upgrade page.

3. Upgrade VeloDB Manager

Note: The webserver component will also be restarted during the upgrade, so the page will automatically exit. Please log in again.