Установка компонента Kintsugi (DBCM)#

Автоматизированная установка сервиса с использованием Docker Compose#

В разделе приведен порядок автоматизированной установки Kintsugi (DBCM) с использованием Docker Compose:

Быстрый старт на стенде с ОС Linux с использованием Platform V DevOps Tools (DOT)#

Для быстрого старта Kintsugi Standard на стенде с ОС Linux с использованием Platform V DevOps Tools (DOT):

  1. Установите Docker и Docker Compose для вашей версии ОС Linux согласно документации продукта.

  2. Распакуйте архивы DBCM-bin-X.X.X-XX-std-distrib.zip, DBCM-cfg-X.X.X-XX-std-distrib.zip и DBCM-dbinit-X.X.X-XX-std-distrib.zip в один каталог.

  3. Перейдите в каталог package/conf.

  4. Скопируйте файл example.env в .env.

  5. Откройте файл .env.

  6. Задайте параметру DOMAIN значение IP-адреса стенда, на котором выполняется установка.

  7. Выполните команду развертывания:

    docker compose up -d --build

    Примечание

    Запуск может занимать до нескольких минут, контейнеры несколько раз перезапустятся.

    В консоли будет виден статус контейнеров.

  8. Запустите Kintsugi Standard, для этого в браузере перейдите по адресу https://<ЗАДАННЫЙ IP-АДРЕС>.

    Примечание

    Если через 5 минут Kintsugi Standard не запускается, проверьте правильность заполнения файла .env согласно примеру конфигурации переменных окружения Docker Compose.

  9. Пройдите процедуру аутентификации предложенным способом, используя для входа предустановленные данные авторизации (логин/пароль) admin/admin.

Быстрый старт на стенде с ОС Linux с использованием скрипта unpack.sh#

Для быстрого старта Kintsugi Standard на стенде с ОС Linux с использованием скрипта DBM-unpack-X.X.X-std-XX-distrib.sh:

  1. Установите Docker и Docker Compose для вашей версии ОС Linux согласно документации продукта.

  2. Распакуйте дистрибутив Kintsugi.

  3. Запустите скрипт DBM-unpack-X.X.X-std-XX-distrib.sh:

    chmod +x DBM-unpack-X.X.X-std-XX-distrib.sh
./DBM-unpack-X.X.X-std-XX-distrib.sh

  4. Перейдите в директорию package/conf.

  5. Скопируйте файл example.env в .env.

  6. В файле .env определите параметр DOMAIN - адрес хоста на котором выполняется установка.

  7. Выполните команду развертывания:

    docker compose up -d --build

    Примечание

    Запуск может занимать до нескольких минут, контейнеры несколько раз перезапустятся.

    В консоли будет виден статус контейнеров.

  8. Запустите Kintsugi Standard, для этого в браузере перейдите по адресу https://<ЗАДАННЫЙ IP-АДРЕС>.

    Примечание

    Если через 5 минут Kintsugi Standard не запускается, проверьте правильность заполнения файла .env согласно примеру конфигурации переменных окружения Docker Compose.

  9. Пройдите процедуру аутентификации предложенным способом, используя для входа предустановленные данные авторизации (логин/пароль) admin/admin.

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

Внимание

Дистрибутив поставляется с преднастроенными конфигурациями, изменение значений параметров не рекомендуется, за исключением параметра DOMAIN.

Пример наполнения файла конфигурации переменных окружения Docker Compose.

Ниже приведено описание параметров и примеры их значений:

Параметр

Пример

Описание

DOMAIN

kintsugi.internal

Домен Kintsugi Standard

BASE_IMAGE

python:3.11

Базовый образ для сервисов Kintsugi Standard

FRONTEND_BASE_IMAGE

nginx:1.27.2

Базовый образ веб-сервера Kintsugi Standard

JDK_IMAGE

openjdk:11

Базовый образ для инициализации Kintsugi Standard

KEYCLOAK_IMAGE

keycloak/keycloak:23.0.4

Образ Keycloak

OPENRESTY_IMAGE

openresty/openresty:1.25.3.2-0-alpine-fat

Образ OpenResty

POSTGRES_PASSWORD_FILE

/run/secrets/postgres_password

Файл, содержащий пароль пользователя postgres

KINTSUGI_REPO_DBNAME

kintsugi

Имя БД метаданных

KINTSUGI_METRICS_DBNAME

kintsugi_metrics

Имя БД метрик

KINTSUGI_REPO_USER_FILE

/run/secrets/repository_username

Путь к файлу с логином БД метаданных

KINTSUGI_REPO_PASSWORD_FILE

/run/secrets/repository_password

Путь к файлу с паролем БД метаданных

KINTSUGI_METRICS_USER_FILE

/run/secrets/monitoring_username

Путь к файлу с логином БД метрик

KINTSUGI_METRICS_PASSWORD_FILE

/run/secrets/monitoring_password

Путь к файлу с паролем БД метрик

KINTSUGI_THRESHOLDS_USER_FILE

/run/secrets/thresholds_username

Путь к файлу с логином БД хранения порогов метрик

KINTSUGI_THRESHOLDS_DBNAME

thresholds

Имя БД хранения порогов метрик

KINTSUGI_THRESHOLDS_PASSWORD_FILE

/run/secrets/thresholds_password

Путь к файлу с паролем БД хранения порогов метрик

KINTSUGI_AGENTS_DBNAME

agents

Имя БД агента сбора и хранения метрик

KINTSUGI_AGENTS_USER_FILE

/run/secrets/agents_username

Путь к файлу с логином БД агента сбора и хранения метрик

KINTSUGI_AGENTS_PASSWORD_FILE

/run/secrets/agents_password

Путь к файлу с паролем БД агента сбора и хранения метрик

KINTSUGI_KEYCLOAK_USER

<ИМЯ ПОЛЬЗОВАТЕЛЯ>

Имя пользователя учетной записи Kintsugi Standard

KINTSUGI_KEYCLOAK_INIT_PASSWORD

<ПАРОЛЬ>

Пароль учетной записи Kintsugi Standard

KINTSUGI_REALM_CLIENT_ID

kintsugi

ID клиента учетной записи Kintsugi Standard в Keycloak

KINTSUGI_REALM_CLIENT_SECRET

<СОДЕРЖАНИЕ СЕКРЕТА>

Секрет учетной записи Kintsugi Standard в Keycloak

KC_PROXY

edge

Режим работы Keycloak

KC_IMPORT_REALM

'true'

Включение/отключение импорта Realm (true/false)

KC_DB_URL

jdbc:postgresql://database.internal:5432/'

Путь к БД Keycloak

KC_DB

postgres

Тип БД

KC_DB_USERNAME

<ИМЯ ПОЛЬЗОВАТЕЛЯ>

Имя пользователя БД Keycloak

KC_DB_PASSWORD

<ПАРОЛЬ>

Пароль БД Keycloak

KC_HTTP_ENABLED

'false'

Включение/отключение HTTP (true – работает на HTTP, false (или не заданно) – HTTPS). Допускается использовать только значение false

KC_HOSTNAME_STRICT_HTTPS

'false'

Включение/отключение ограничений на использование HTTPS (true/false –не будет проверять домен на соответствие)

KC_HOSTNAME_STRICT

'false'

Включение/отключение динамического преобразования в заголовках запроса (true/false)

KEYCLOAK_ADMIN

<ИМЯ ПОЛЬЗОВАТЕЛЯ>

Имя пользователя Keycloak

KEYCLOAK_ADMIN_PASSWORD

<ПАРОЛЬ>

Пароль Keycloak

KC_HOSTNAME_ADMIN

${DOMAIN}

FQDN админ панели Keycloak

KC_AUTO_BUILD

'true'

Включение/отключение автоматической инициализации Keycloak при первом запуске (true/false)

KC_HTTP_PORT

8080

Порт Keycloak

KC_LOG_LEVEL

INFO

Переключатель уровня логирования для всех модулей Kintsugi: ERROR/DEBUG/INFO/WARN

KC_HEALTH_ENABLED

true

Включение контроля работоспособности Keycloak. Допускается использовать только значение true

KC_HTTPS_CERTIFICATE_FILE

/opt/keycloak/conf/truststores/certs/cert.pem

Путь к сертефикату Keycloak

KC_HTTPS_CERTIFICATE_KEY_FILE

/opt/keycloak/conf/truststores/certs/key.pem

Ключ сертефиката Keycloak

KC_HTTPS_PROTOCOLS

TLSv1.3,TLSv1.2

Версии протоколов TLS, разрешенных к использованию Keycloak

KEYCLOAK_DOMAIN

${DOMAIN}

Домен Keycloak

KEYCLOAK_REALM

kintsugi

Имя Realm с настройками Kintsugi Standard

KEYCLOAK_REALM_CLIENT_ID

<ИМЯ ПОЛЬЗОВАТЕЛЯ>

ID клиента учетной записи Kintsugi в OpenResty

KEYCLOAK_REALM_CLIENT_SECRET

<СОДЕРЖИМОЕ СЕКРЕТА>

Секрет учетной записи Kintsugi в OpenResty

COMPOSE_PROJECT_NAME

kintsugi

Имя проекта Compose