Репозиторий Docker

Внимание

Дисклеймер.

Статья не является готовой инструкцией по установке Юниверс MDM.

Ее цель - показать общий порядок развертывания системы, состав необходимых компонентов и последовательность работ. Конкретные действия, параметры конфигурации и команды зависят от используемой инфраструктуры, политики безопасности, версии операционной системы, архитектуры кластера и других особенностей вашего окружения.

Эта статья не позволит установить систему "как есть" на любой сервер. Вместо этого она поможет:

определить необходимые этапы установки;
подобрать команды и параметры для каждого этапа;
подготовить собственные конфигурационные файлы;
оформить внутреннюю документацию по развертыванию;
выполнить установку в соответствии с этой документацией.

Во всех разделах ниже приведены примеры и ссылки на детальные инструкции по настройке отдельных компонентов.

Рекомендуемый способ установки Юниверс MDM - c использованием Docker.

Порядок развертывания

Ниже приведены основные этапы установки системы с использованием Docker. Детали каждого шага раскрыты в соответствующих разделах данной страницы или в связанных руководствах.

Предварительные условия
- Операционная система (в примере - Ubuntu, также поддерживается Astra Linux Special Edition и другие, см. системные требования).
- Установленные Docker и Docker Compose (версия 1.29 или выше).
- Пользователь с правами sudo.
- Наличие архива с Docker-образами дистрибутива Юниверс MDM (полученного согласно договору поставки). Архив включает все необходимые образы, плагины и расширения.
Получение образов и подготовка окружения
- Загрузка и импорт Docker-образов из репозитория.
- Подготовка сервера: установка Docker, Git, настройка прав.
- Создание конфигурационных файлов (docker-compose.yaml, .env, init-db.sh) и папки словарей Hunspell.
Конфигурирование компонентов
- Настройка PostgreSQL и TimescaleDB (сборка образа с расширением, см. Установка PostgreSQL и TimescaleDB).
- Настройка OpenSearch (одна нода или кластер, выделение RAM, смена пароля) - см. руководство по Astra Linux.
- При необходимости - настройка SSL/TLS для OpenSearch, PostgreSQL и Tomcat (генерация сертификатов, truststore/keystore) - см. руководство по Astra Linux.
Запуск окружения и системы
Порядок запуска компонентов (при использовании docker-compose соблюдается автоматически, при ручном запуске - рекомендуется):
Postgres (опционально, если не используется внешняя база);

OpenSearch;

MDM (backend);

Nginx (frontend).
- Запуск всех сервисов одной командой: docker-compose up -d.

Подготовка к установке

Подготовка сервера:

Обновите существующий список пакетов Ubuntu. Команда: sudo apt update
Установите Docker через официальный репозиторий. Документацию см. по ссылке https://docs.docker.com/
Установите Docker Compose (версия выше 1.29).
Настройте разрешения для Docker Compose. Пример команды: sudo chmod +x /usr/local/bin/docker-compose
Установите Git.

Настройка SSL для OpenSearch (генерация сертификатов, truststore/keystore) – пример для Ubuntu

Репозиторий Docker:

Согласно договору поставки Юниверс MDM получите доступ к репозиторию с дистрибутивом вашего продукта:

Основной путь: получите архив с Docker-образами дистрибутива и поместите его в собственный репозиторий через локальный Dockerhub.
Альтернативный путь: Согласно договору поставки Юниверс Дата получите доступ к репозиторию с дистрибутивом вашего продукта.

Установка Юниверс MDM

Убедитесь, что ссылка на репозиторий с дистрибутивом вашего продукта в наличии. О получении ссылки см. выше.
Клонируйте репозиторий из Gitlab или Docker. Пример команды:
```
git clone [your-link-universe-platform-deploy.git]
```
Перейдите в каталог с проектом. Пример команды:
```
cd universe-platform-deploy
```
Авторизуйтесь в репозитории с помощью команды (используя логин / пароль):
```
sudo docker login repo/universe-mdm-deploy
```
Для запуска системы используйте команду:
```
docker-compose up -d
```

По умолчанию пользовательский интерфейс доступен для просмотра на localhost:8082.

Логин и пароль по умолчанию: admin/ admin. После введения логина и пароля система запросит файл лицензии и смену пароля.

Установка PostgreSQL и TimescaleDB

Базовый образ postgres:16.3 не содержит расширения TimescaleDB. Чтобы использовать TimescaleDB, необходимо создать собственный образ на его основе. Для этого потребуется создать Dockerfile и выполнить сборку.

Пример Dockerfile (используйте как основу):

FROM postgres:16.3
RUN apt-get update \
    && apt-get install -y --no-install-recommends \
        wget gnupg lsb-release software-properties-common ca-certificates
RUN wget --quiet -O - https://packagecloud.io/timescale/timescaledb/gpgkey | \
    gpg --dearmor -o /usr/share/keyrings/timescaledb-archive-keyring.gpg \
    && echo "deb [signed-by=/usr/share/keyrings/timescaledb-archive-keyring.gpg] \
    https://packagecloud.io/timescale/timescaledb/debian/ $(lsb_release -cs) main" \
    > /etc/apt/sources.list.d/timescaledb.list
RUN apt-get update \
    && apt-get install -y --no-install-recommends timescaledb-2-postgresql-16
RUN echo "shared_preload_libraries = 'timescaledb'" >> /usr/share/postgresql/postgresql.conf.sample

После сборки образа укажите его в секции image сервиса postgres-mdm в docker-compose.yaml.

В настройках сервера PostgreSQL (передаваемых через command или файлы конфигурации) рекомендуется указать:

max_connections = 1000
max_prepared_transactions = 300
listen_addresses = '*'

Детали по настройке самого PostgreSQL, смене пароля, созданию тестовой БД и активации TimescaleDB см. в разделе "Настройка PostgreSQL" руководства по Astra Linux.

Пользовательская установка с Docker Compose

Примечание

Версия docker-compose должна быть 1.29 или выше

При необходимости используйте docker-compose.yaml для создания собственного образа. В файле .env содержится полный перечень доступных переменных. Описание файла см. ниже.

Порядок действий:

В типовом варианте развертывания создается файл docker-compose.yaml.
Также создается папка hunspell со словарями. См. также инструкцию по настройке библиотеки Hunspell.
Вы можете пересоздать docker-контейнер с новыми настройками с помощью команды:
```
docker-compose up -d --build --force-recreate
```

Ниже приведен один из возможных вариантов docker-compose.yaml

version: '2.4'
services:
  setup_json:
    image: stedolan/jq:latest
    entrypoint: >
      sh -c "
      cd /opt/json_configs;
      [ ! -z ${OVERRIDE_JSON:-''} ] &&
      jq -s '.[0] * .[1]' customer.json ${OVERRIDE_JSON}
      > ../customer.json ||
      cp customer.json ../customer.json"
    volumes:
      - ./:/opt

  ui:
    image: ${FRONTEND_IMAGE}
    restart: always
    ports:
      - ${FRONTEND_PORT}:80
    networks:
      - mdm_network
    links:
      - mdm
    volumes:
      - ${FRONTEND_UE:-/dev/null}:/usr/share/nginx/html/CUX
      - ./customer.json:/usr/share/nginx/html/customer.json
    environment:
      BACKEND_ADDRESS: ${BACKEND_ADDRESS}
      CLIENT_MAX_BODY_SIZE: ${CLIENT_MAX_BODY_SIZE}
      PROXY_SEND_TIMEOUT: ${PROXY_SEND_TIMEOUT}
      PROXY_READ_TIMEOUT: ${PROXY_READ_TIMEOUT}
      SEND_TIMEOUT: ${SEND_TIMEOUT}
    depends_on:
      setup_json:
        condition: service_completed_successfully

  mdm:
    image: ${BACKEND_IMAGE}
    restart: always
    ports:
      - ${BACKEND_PORT}:8080
    networks:
      - mdm_network
    environment:
      GUEST_MODE: ${GUEST_MODE}
      POSTGRES_ADDRESS: postgres-mdm:5432
      POSTGRES_USERNAME: ${MDM_POSTGRES_USER}
      POSTGRES_PASSWORD: ${MDM_POSTGRES_PASSWORD}
      DATABASE_NAME: ${MDM_POSTGRES_DB_NAME}
      SEARCH_CLUSTER_ADDRESS: opensearch-mdm:9200
      SEARCH_CLUSTER_NAME: docker-cluster
      # Если восстановление пароля не требуется, переменные EMAIL_* можно не задавать
      EMAIL_ENABLED: ${RESTORE_EMAIL_ENABLED}
      EMAIL_SERVER_HOST: ${RESTORE_EMAIL_SERVER_HOST}
      EMAIL_SERVER_PORT: ${RESTORE_EMAIL_SERVER_PORT}
      EMAIL_USERNAME: ${RESTORE_EMAIL_USERNAME}
      EMAIL_PASSWORD: ${RESTORE_EMAIL_PASSWORD}
      EMAIL_FRONTEND_URL: ${RESTORE_EMAIL_FRONTEND_URL}
      EMAIL_SSL_ENABLE: ${RESTORE_EMAIL_SSL_ENABLE}
      EMAIL_STARTTLS_ENABLE: ${RESTORE_EMAIL_STARTTLS_ENABLE}
      JAVA_TOOL_OPTIONS: ${JAVA_TOOL_OPTIONS:-}
    depends_on:
      postgres-mdm:
        condition: service_healthy
      opensearch-mdm:
        condition: service_healthy

  postgres-mdm:
    image: your-custom-postgres-timescaledb:latest   # образ, собранный по Dockerfile выше
    restart: always
    environment:
      POSTGRES_DB: ${MDM_POSTGRES_DB_NAME}
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      MDM_POSTGRES_USER: ${MDM_POSTGRES_USER}
      MDM_POSTGRES_PASSWORD: ${MDM_POSTGRES_PASSWORD}
      TZ: ${TIMEZONE:-UTC}
    ports:
      - ${POSTGRES_OUTER_PORT}:5432
    networks:
      - mdm_network
    volumes:
      - ./init-db.sh:/docker-entrypoint-initdb.d/initdb.sh
      - mdm-postgres-data:/var/lib/postgresql/data
    command: postgres -c max_connections=1000 -c max_prepared_transactions=300 -c shared_preload_libraries='timescaledb'
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U postgres -d $MDM_POSTGRES_DB_NAME"]
      interval: 10s
      timeout: 1s
      retries: 20

  opensearch-mdm:
    image: opensearchproject/opensearch:2.14.0
    restart: always
    environment:
      - "OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m"
      - "discovery.type=single-node"
      - "DISABLE_SECURITY_PLUGIN=true"
    volumes:
      - mdm-opensearch-data:/usr/share/opensearch/data
      - ./hunspell:/usr/share/opensearch/config/hunspell/
    ulimits:
      memlock:
        soft: -1
        hard: -1
    ports:
      - ${OPENSEARCH_HTTP_OUTER_PORT}:9200
    networks:
      - mdm_network
    healthcheck:
      test: >
        bash -c "curl http://localhost:9200 | grep '\"cluster_name\"'"
      interval: 10s
      timeout: 2s
      retries: 20

volumes:
  mdm-postgres-data:
    driver: local
  mdm-opensearch-data:
    driver: local

networks:
  mdm_network:
    driver: bridge

Детальные инструкции по настройке компонентов, общие для всех способов установки, находятся в руководстве "Закрытый контур на Astra Linux". В частности:

Настройка PostgreSQL (включая смену пароля, создание тестовой БД, SSL-подключения).
Настройка OpenSearch (конфигурация, RAM, смена пароля, кластер).
Настройка SSL для OpenSearch (генерация сертификатов, truststore/keystore).
Настройка SSL/TLS для подключения к PostgreSQL (параметры в setenv.sh и backend.properties).
Установка и настройка Tomcat, включая SSL/TLS и конфигурацию server.xml.

Используйте эти инструкции для создания собственного docker-compose.yaml и конфигурационных файлов, адаптируя их под свои нужды.

Логи BTM (Bitronix Transaction Manager) в контейнере Docker доступны через docker logs <имя_контейнера_mdm>. При ручной установке пути к логам описаны в разделе "Закрытый контур на Astra Linux".

Описание файла .env

Файл .env содержит значения переменных, используемых в docker-compose.yaml. Вынесение параметров в отдельный файл позволяет легко изменять конфигурацию без правки основного yaml-файла и переопределять значения для разных окружений.

Для заполнения .env важно понимать:

какие порты будут использоваться;
где будет размещена PostgreSQL;
будет ли использоваться внешний OpenSearch;
какие Docker-образы применяются;
какие параметры безопасности используются (SSL, пароли и т.д.).

BACKEND_IMAGE, FRONTEND_IMAGE - ссылки на backend и frontend образы; различаются в зависимости от редакции.
OPENSEARCH_HTTP_OUTER_PORT, POSTGRES_OUTER_PORT, FRONTEND_PORT, BACKEND_PORT - внешние порты соответствующих контейнеров, т.е. порты, к которым может извне подключиться docker кластера. Значения могут быть произвольными; имена должны соответствовать файлу docker-compose.yaml.
MDM_POSTGRES_USER, MDM_POSTGRES_PASSWORD, MDM_POSTGRES_DB_NAME - имя пользователя, пароль и имя БД; различаются в зависимости от редакции; должны соответствовать файлу docker-compose.yaml.
GUEST_MODE - параметр, позволяющий активировать гостевой доступ; доступен только в Enterprise редакции.
RESTORE_EMAIL - параметры, отвечающие за восстановление пароля.
Если восстановление пароля не используется, переменные RESTORE_EMAIL можно не задавать или оставить пустыми. Соответствующие строки в docker-compose.yaml можно удалить или закомментировать.
Группа параметров nginx.conf:
- BACKEND_ADDRESS - значение берется из одноименной секции в файле docker-compose.yaml - в примере используется значение mdm.

Пример файла .env:

BACKEND_IMAGE=docker.universe-data.ru/unidata-ee/backend:release-6-12-2e7524c1
FRONTEND_IMAGE=docker.universe-data.ru/unidata-ee/frontend:release-6-12-c64b51a2

OPENSEARCH_HTTP_OUTER_PORT=19201

MDM_POSTGRES_USER=postgres
MDM_POSTGRES_PASSWORD=postgres
MDM_POSTGRES_DB_NAME=postgres
POSTGRES_OUTER_PORT=15431

FRONTEND_PORT=8082
BACKEND_PORT=9081

GUEST_MODE=false

#TIMEZONE=Europe/Moscow

RESTORE_EMAIL_ENABLED=false
RESTORE_EMAIL_SERVER_HOST=localhost
RESTORE_EMAIL_SERVER_PORT=5025
RESTORE_EMAIL_USERNAME=universe@example.com
RESTORE_EMAIL_PASSWORD=password
RESTORE_EMAIL_FRONTEND_URL=''
RESTORE_EMAIL_SSL_ENABLE=true
RESTORE_EMAIL_STARTTLS_ENABLE=false

#nginx.conf
BACKEND_ADDRESS=http://mdm:8080
CLIENT_MAX_BODY_SIZE=100m
PROXY_SEND_TIMEOUT=600s
PROXY_READ_TIMEOUT=600s
SEND_TIMEOUT=600s

### Settings for cluster (run command: docker-compose -f docker-compose-cluster.yaml up -d) ###
FRONTEND_PORT_2=8083
BACKEND_PORT_2=9082
BACKEND_ADDRESS_2=http://mdm2:8080
CACHE_AUTO_DETECTION_ENABLED=true
CACHE_GROUP=unidata
CACHE_PASSWORD=password
CACHE_PORT=5701
CACHE_PORT_AUTOINCREMENT=false
CACHE_TCP_IP_ENABLED=true
CACHE_TCP_IP_MEMBERS=mdm,mdm2
CACHE_PUBLIC_ADDRESS=mdm:5701
CACHE_PUBLIC_ADDRESS_2=mdm2:5701
SYSTEM_NODE_ID=node0
SYSTEM_NODE_ID_2=node1
### Settings for cluster ###

#ActiveMQ
ACTIVEMQ_ADMIN_LOGIN=admin
ACTIVEMQ_ADMIN_PASSWORD=admin

Устранение возможных проблем

После установки может возникать ошибка с файлом customer.json (ее видно в консоли разработчика в браузере, клавиша F12). Ошибка возникает не всегда, иногда права устанавливаются верно. В случае ошибки необходимо проверить права на файл, они должны быть 644. Если права отличаются, выполнить команду:

chmod 644 customer.json