Install a cluster

Step 1. Precheck

Before installing a new cluster it is recommended to run the Precheck action. By doing this, you make sure that all necessary repositories are available, the cluster does not contain hosts with the same IP addresses, and all other prerequisites are met. Do the following:

  1. Apply the Precheck action to the cluster selected on the Clusters page by clicking the actions default dark actions default light icon in the Actions column.

    Run a cluster precheck
    Run the cluster precheck
  2. Verify the requested action in the opened window.

    precheck verify
    Verify the action
  3. Open the Jobs page and wait until the running job is completed. After this, click the first item in the job list.

    View jobs
    View jobs
  4. View logs in the window that opens. To download logs, click Download.

    Job logs
    View logs

Step 2. Run installation

There are two ways to install cluster services:

  1. Whole cluster. In this method all services are installed automatically one by one after applying the Install action to a cluster.

  2. Single services. In this method each service is installed manually after applying one or more actions to it. This way is also suitable for installing new services in the already deployed cluster.

In both cases each service starts automatically after installation.

NOTE
In case of errors, you can find logs on the Jobs page.

Whole cluster

To install all cluster services within a single action, follow the steps:

  1. Apply the Install action to the cluster selected on the Clusters page by clicking the actions default dark actions default light icon in the Actions column.

    Switch to the whole cluster installation
    Switch to the whole cluster installation
  2. Verify the requested action in the opened window.

  3. Wait until the job is completed.

  4. If some service fails during installation, but the preceding services are installed successfully, you can try to fix errors and restart installation of all failed services. To do this, select the Reinstall action in the Actions column on the Clusters page.

    Installation restart
    Installation restart

Single services

The recommended way to install ADB ES is to use the Install cluster action (as described above). Alternatively, you can install all services manually, one by one. If you choose this method, follow the installation order below:

  1. Database, Clickhouse, and AD Eureka (in any order)

  2. ADB Control

  3. ADBM

To install services one by one, follow the steps:

  1. Open the Services tab on the cluster page. For each service that should be installed, click the actions default dark actions default light icon in the Actions column and select the Install action.

    Install single services
    Switch to installation of single services
  2. Verify the action in the opened window.

    Verify the action
    Verify the action
  3. Wait until the job is completed. Then check that the service state has changed from created to installed.

Step 3. Check the cluster state after installation

As a result of successful installation, the cluster and its services change their state according to the following rules:

  • The cluster state, displayed in the State field on the Clusters page, is being changed from created to installed.

    The cluster state after successful installation
    The cluster state after successful installation
  • The state of cluster services, displayed on the Services tab of the cluster page, is being changed from created to installed.

    The state of cluster services after successful installation
    The state of cluster services after successful installation

Step 4. Check the ADB Control web interface

After ADB ES installation is complete, check the ADB Control web interface:

  1. In a browser, enter <adb_control_host>:8890 where adb_control_host is the hostname or IP address of a host that you have mapped to ADB Control and 8890 is the default port for the ADB Control UI. This port can be changed in the ADB Control service configuration, in UI component parameters → Listening port.

    NOTE
    The IP address and port of ADB Control are also listed on the Info tab of the ADB Control service.
  2. To sign in, use the default credentials:

    • Username: admin

    • Password: 1234

      When you sign in for the first time, you will be prompted to change the default password.

  3. Open the Information tab and check the version, status, and uptime of the installed components.

Information tab in ADB Control user interface
Information tab in ADB Control user interface
Found a mistake? Seleсt text and press Ctrl+Enter to report it