Установка

Дарья Барышева

Содержание

Online-установка с использованием Docker-образа
Offline-установка (доступно в Enterprise Edition)
Запуск и остановка
Проверка установки

Online-установка с использованием Docker-образа

ПРИМЕЧАНИЕ

В продуктовой среде рекомендуется использовать PostgreSQL в качестве внешней базы данных вместо встроенной SQLite. Дополнительную информацию можно получить в статье Настройка ADCM для использования внешней базы данных.
Для просмотра полного списка доступных образов можно обратиться к репозиторию ADCM на Docker Hub.
Все данные ADCM сохраняются в папке /adcm/data внутри Docker-контейнера. Во избежание потерь данных рекомендуем примонтировать к контейнеру том (Docker Volume) с последующей настройкой его бэкапов.

Для установки ADCM необходимо выполнить следующие команды:

Скачайте Docker-образ из Arenadata Docker Registry.

$ sudo docker pull hub.arenadata.io/adcm/adcm:<version>

где <version> — это версия Docker-образа в одном из следующих форматов:

<major>.<minor>.<patch> — если необходим конкретный патч ADCM. Пример: 2.0.0.
<major>.<minor> — если необходим последний патч в рамках выбранной версии ADCM. Пример: 2.0.

ВАЖНО

latest использовался для ранних версий ADCM и, начиная с версии 2.0.0, больше не поддерживается.
До выпуска ADCM 2.0.0 для версионирования использовался следующий формат: YYYY.MM.DD.HH.

Создайте Docker-контейнер на основе загруженного образа. Приведенная ниже команда создает контейнер с ADCM на порте 8000. Все данные контейнера будут храниться в директории /opt/adcm/.
```
$ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data hub.arenadata.io/adcm/adcm:<version>
```
Если требуется запустить ADCM с включенным SELinux, при создании Docker-контейнера необходимо указать опцию :Z в параметре, содержащем имя каталога данных:
```
$ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data:Z hub.arenadata.io/adcm/adcm:<version>
```
Опционально при создании контейнера можно указать переменные окружения, перечисленные ниже. Каждая переменная указывается в формате -e <name>="<value>". Пример:

$ sudo docker create --name adcm -p 8000:8000 -v /opt/adcm:/adcm/data -e LOG_LEVEL="INFO" hub.arenadata.io/adcm/adcm:<version>

ПРИМЕЧАНИЕ

Специальные переменные окружения, такие как STATUS_LOG_LEVEL, ADCM_LOG_LEVEL, AUDIT_LOG_LEVEL, LDAP_LOG_LEVEL, BACKGROUND_TASKS_LOG_LEVEL и TASK_RUNNER_LOG_LEVEL, являются более приоритетными, чем переменная окружения LOG_LEVEL.

Переменные окружения

Имя Описание

DEFAULT_ADCM_URL

URL хоста, на котором разворачивается контейнер ADCM. Указывается в формате: http://<IP>:8000/. Если переменная не указана при создании контейнера, URL необходимо будет заполнить вручную в поле ADCM’s URL на странице Settings

LOG_LEVEL

Уровень логирования для всех типов логов. Возможные значения:

DEBUG
INFO
WARNING
ERROR (значение по умолчанию)
CRITICAL

STATUS_LOG_LEVEL

Уровень логирования для status.log. Возможные значения:

DEBUG
INFO
WARNING
ERROR
CRITICAL

ADCM_LOG_LEVEL

Уровень логирования для adcm.log и adcm_debug.log. Возможные значения:

DEBUG
INFO
WARNING
ERROR
CRITICAL

AUDIT_LOG_LEVEL

Уровень логирования для audit.log. Возможные значения:

DEBUG
INFO (значение по умолчанию)
WARNING
ERROR
CRITICAL

LDAP_LOG_LEVEL

Уровень логирования для ldap.log. Возможные значения:

DEBUG
INFO
WARNING
ERROR
CRITICAL

BACKGROUND_TASKS_LOG_LEVEL

Уровень логирования для cron_task.log. Возможные значения:

DEBUG
INFO
WARNING
ERROR
CRITICAL

TASK_RUNNER_LOG_LEVEL

Уровень логирования для task_runner.err. Возможные значения:

DEBUG
INFO
WARNING
ERROR
CRITICAL

DB_HOST

Имя или IP-адрес хоста, на котором развернута внешняя БД PostgreSQL. Дополнительную информацию по переменным DB_HOST, DB_PORT, DB_USER, DB_NAME, DB_PASS, DB_OPTIONS можно получить в статье Настройка ADCM для использования внешней базы данных

DB_PORT

Номер TCP-порта для подключения к PostgreSQL

DB_USER

Имя пользователя для подключения к PostgreSQL

DB_NAME

Название базы данных PostgreSQL

DB_PASS

Пароль пользователя для подключения PostgreSQL

DB_OPTIONS

Параметры для подключения к внешней базе данных. Дополнительную информацию можно получить в статье Настройка ADCM для использования внешней базы данных

MIGRATION_MODE

Флаг, указывающий на использование режима миграции — переноса базы данных ADCM с SQLite на PostgreSQL. Дополнительную информацию можно получить в статье Миграция ADCM. Возможные значения:

0 — режим миграции выключен;
1 — режим миграции включен.

Offline-установка (доступно в Enterprise Edition)

При использовании версии Enterprise дополнительно доступна offline-установка ADCM. Она подходит для развертывании системы на хостах без доступа к Интернету. Offline-установка ADCM включает следующие шаги:

Запросите специальный установочный shell-скрипт у команды поддержки Arenadata.
Создайте директорию на хосте, где должен быть развернут ADCM, и разместите в ней полученный скрипт.
Запустите скрипт из созданной директории, используя следующую команду:
```
$ sudo bash <script_name> master_adcm
```
где <script_name> означает полное имя скрипта с расширением (например, pack.sh).

ПРИМЕЧАНИЕ

В продуктовой среде рекомендуется использовать PostgreSQL в качестве внешней базы данных вместо встроенной SQLite. Дополнительную информацию можно получить в статье Настройка ADCM для использования внешней базы данных.
Offline-установка занимает некоторое время. Пожалуйста, дождитесь ее завершения. Результат обработки команды может выглядеть следующим образом:
```
Loaded image: hub.arenadata.io/adcm/adcm:2.0
e97f2afb04e568386b2755ef8b1d245eb2abfab77c2a402f736e0c1cd99e7b11
adcm
```

Запуск и остановка

Поскольку ADCM представляет собой контейнер под управлением Docker, за его запуск и установку отвечают стандартные Docker-команды:

Запуск ADCM.
```
$ sudo docker start adcm
```
Остановка ADCM.
```
$ sudo docker stop adcm
```
Автозапуск ADCM. Чтобы настроить автоматический запуск Docker-контейнера в случае непредвиденных ошибок, используйте следующую команду.
```
$ sudo docker update --restart=on-failure adcm
```

ПРИМЕЧАНИЕ

Дополнительная информация по политикам перезапуска Docker-контейнеров (restart policies) может быть получена из документации Docker.
Если для текущего пользователя настроен доступ к Docker CLI без использования прав root, слово sudo в предыдущих командах необязательно.

Проверка установки

Проверка статуса Docker-контейнера

Чтобы убедиться в успешной установке Docker-контейнера adcm, выполните следующую команду.

$ sudo docker container ls

Пример результата выполнения команды приведен ниже. Убедитесь, что в столбце STATUS выводится значение Up:

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

Проверка доступности порта 8000

После установки и запуска ADCM его web-интерфейс должен стать доступным на 8000 порте развернутого контейнера.

Для операционной системы Ubuntu 22.04 предварительно установите пакет для запуска команды netstat:

$ sudo apt-get install net-tools

Для проверки доступности порта выполните команды:

netstat — для вывода информации о состоянии порта.

$ sudo netstat -ntpl | grep 8000

Пример результата выполнения команды:

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

curl — для проверки URL-соединения.

$ curl http://localhost:8000

Пример результата выполнения команды:

<!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>

Проверка web-интерфейса ADCM

При установке ADCM автоматически создается пользователь с административными правами. Чтобы зайти в ADCM, используйте следующие учетные данные:

User: admin
Password: admin

Вход в ADCM

Для изменения пароля требуется выполнить следующие действия:

Откройте профиль текущего пользователя в левом навигационном меню.
Введите текущий пароль в поле Current password.
Укажите новый пароль в поле New password.
Подтвердите новый пароль в поле Confirm password.
Нажмите Save.

Изменение пароля пользователя admin

Установка URL ADCM

Для успешного обмена данными между ADCM и развернутыми с его помощью кластерами важно корректное определение внешнего адреса ADCM. В дальнейшем этот адрес будет использоваться для отправки в ADCM статусов кластерных компонентов. Для указания URL ADCM используется переменная окружения DEFAULT_ADCM_URL при создании контейнера ADCM. Если переменная не была указана, необходимо установить URL вручную в web-интерфейсе ADCM. Для этого выполните шаги:

Выберите пункт Settings в левом навигационном меню.
Раскройте узел Global Options в дереве конфигурационных настроек.
Нажмите на значение поля ADCM’s URL.

Страница Settings
В открывшемся окне измените значение ADCM’s URL и нажмите Apply.

Редактирование URL ADCM
Нажмите Save для сохранения внесенных изменений.

Сохранение URL ADCM

Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней