Installation

Daria Barysheva

Online installation via a Docker Image

To install ADCM, you should run the following commands:

  1. Pull a Docker Image from the Arenadata Docker Registry.

    $ sudo docker pull hub.arenadata.io/adcm/adcm:latest

  2. Add a container based on that image. The command below creates a container on the port 8000 with ADCM. All its data will be stored on the host machine in the /opt/adcm/ directory.

    $ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data hub.arenadata.io/adcm/adcm:latest

    If you want to run ADCM with SELinux enabled, a Docker container should be created with the :Z option in the data catalog parameter:

    $ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data:Z hub.arenadata.io/adcm/adcm:latest
NOTE

  • You can download not only the latest Docker image, but also the specified one. To do this, use the image name instead of the latest keyword in the commands listed above. To see the full list of images, refer to the ADCM repository on Docker Hub.

  • ADCM has some mandatory persistent information that is stored in the /adcm/data directory inside of a container. This means that you have to map a volume to that directory and provide for that volume backups.

Offline installation (available in the Enterprise Edition)

If you use Enterprise Edition of the product, you can also try offline installing of ADCM. It can be useful in situations without Internet access. Offline installing of ADCM includes the following steps:

  1. Get a special installation shell script from the Arenadata support team.

  2. Make a directory on the host, where ADCM should be deployed, and put the script into it.

  3. Run the script from the created directory, using the following command:

    $ sudo bash <script_name> master_adcm

     — where <script_name> means the full script name with an extension (for example, pack.sh).

NOTE

Offline installing takes some time. Please, wait until it is completed. The result should look like this:

Loaded image: hub.arenadata.io/adcm/adcm:latest
e97f2afb04e568386b2755ef8b1d245eb2abfab77c2a402f736e0c1cd99e7b11
adcm

Start and stop

ADCM is just a container operated by Docker. So you are able to use simple Docker commands to start and stop ADCM:

  • To start ADCM, use the following command.

    $ sudo docker start adcm

  • To stop ADCM, use the following command.

    $ sudo docker stop adcm

  • In order to provide the automatic start of the Docker container after unexpected errors, use the following command.

    $ sudo docker update --restart=on-failure adcm
NOTE

  • For more information about Docker restart policies, refer to the Docker documentation.

  • If you allowed your user to access the Docker CLI without root privileges, then you can omit the sudo keyword from the commands listed above.

  • If you want to use ADCM with an external database, see Configure ADCM to use an external database.

Checking installation

Check the Docker container status

To make sure that the Docker container adcm is successfully deployed, run the following command.

$ sudo docker container ls

The result is listed below. Make sure that the STATUS value is equal to Up.

CONTAINER ID        IMAGE                               COMMAND             CREATED             STATUS              PORTS                    NAMES
74b5628146e5        hub.arenadata.io/adcm/adcm:latest   "/etc/startup.sh"   4 days ago          Up 21 minutes       0.0.0.0:8000->8000/tcp   adcm

Check the 8000 port availability

After ADCM is installed and started, its web interface should become available on the 8000 port of the deployed container. You can check it using these commands:

  • The netstat command — to display information about port listening.

    $ sudo netstat -ntpl | grep 8000

    The output data should look like this:

    tcp6       0      0 :::8000                 :::*                    LISTEN                                             1514/docker-proxy-c

  • The curl command — to check the URL connection.

    $ curl http://localhost:8000

    The output data should look like this:

    <!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Arenadata Cluster Manager</title>
  <base href="/">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <link rel="icon" type="image/x-icon" href="assets/favicon.ico">
<link rel="stylesheet" href="styles.10db6328264e0907c52f.css"></head>
<body>
  <app-root></app-root>
<script src="runtime-es2015.7eb406ed18bf0258cd35.js" type="module"></script><script src="runtime-es5.7eb406ed18bf0258cd35.js" nomodule defer></script><script src="polyfills-es5.2e224d70daec4412d3c2.js" nomodule defer></script><script src="polyfills-es2015.37e0553ac06970d6a5b5.js" type="module"></script><script src="main-es2015.39851da0ebf9ed6fec45.js" type="module"></script><script src="main-es5.39851da0ebf9ed6fec45.js" nomodule defer></script></body>
</html>

Check the ADCM web-interface

To log in to ADCM, you should use the user with administrator rights that is created by default:

  • Login: admin

  • Password: admin

adcm install 02
Log in to ADCM

Later you can change the password, if necessary. To do this:

  1. Open the account menu in the top right corner of the screen.

  2. Click the Profile list item in the account menu.

  3. In the window that opens, change the password and confirm it.

  4. Click Save.

    adcm install 06
    Changing the admin password

Check the ADCM URL

If the ADCM container ends up on the network using NAT, it makes impossible the automatic determining the address of the ADCM container that is used by clusters components for sending information about their state to ADCM.

In this and other cases of complicated network structures, you may need to specify the ADCM URL manually. To do this:

  1. Open the account menu in the top right corner of the screen.

  2. Click the Settings list item in the account menu.

  3. Select the Settings tab.

  4. Check the correctness of the automatically determined URL in the ADCM’s URL field and replace it with a valid one, if necessary.

    adcm install 01
    Checking the ADCM URL

  5. Click Save.

    adcm install 04
    Saving the ADCM URL
Found a mistake? Seleсt text and press Ctrl+Enter to report it