Docker через загрузку образов из файла

Внимание

Дисклеймер.

Инструкция содержит примерный порядок действий по установке. Инструкция призвана описать логику действий по установке на простом, абстрактном примере. В зависимости от инфраструктуры сервера (кластера) и его конфигурации, вам могут понадобиться дополнительные или иные шаги.

Эта инструкция не должна восприниматься буквально, а использоваться в качестве основы действий.

Рекомендуемый способ установки Юниверс MDM - с использованием Docker. Данная страница описывает вариант, когда образы Docker получены в виде файлов (tar-архивов) и загружаются в локальный Docker.

Также система может устанавливаться вручную. Этот метод установки требует специальных навыков и зависит от множества параметров: деталей проекта, ИТ-инфраструктуры, параметров интеграции и т.д.

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

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

1. Предварительные условия

   • Операционная система Linux (в примере - Ubuntu, также поддерживается Astra Linux Special Edition).

   • Установленные Docker и Docker Compose (версия 1.29 или выше).

   • Пользователь с правами sudo.

   • Наличие архива с Docker-образами дистрибутива Юниверс MDM (полученного согласно договору поставки). Архив включает все необходимые образы, плагины и расширения.

2. Получение образов и подготовка окружения

   • Получение архива(ов) с образами через согласованный канал (менеджер, FTP и т.п.).

   • Загрузка образов в локальный Docker с помощью команды docker load.

   • Подготовка сервера: установка Docker, Git, настройка прав (см. Подготовка к установке).

   • Создание конфигурационных файлов (docker-compose.yaml, .env, init-db.sh) и папки словарей Hunspell (см. Пользовательская установка с Docker Compose).

3. Конфигурирование компонентов

   • Настройка PostgreSQL и TimescaleDB (сборка образа с расширением, см. Установка PostgreSQL и TimescaleDB).

   • Настройка OpenSearch (одна нода или кластер, выделение RAM, смена пароля) - см. руководство по Astra Linux.

   • При необходимости - настройка SSL/TLS для OpenSearch, PostgreSQL и Tomcat (генерация сертификатов, truststore/keystore) - см. руководство по Astra Linux.

4. Запуск окружения и системы

   Порядок запуска компонентов (при использовании docker-compose соблюдается автоматически, при ручном запуске - рекомендуется):

   1. Postgres (опционально, если не используется внешняя база);

   2. OpenSearch;

   3. MDM (backend);

   4. Nginx (frontend).

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

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

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

• Обновите существующий список пакетов Ubuntu. Команда:

  sudo apt update
  

• Установите Docker.

• Установите Docker Compose (версия выше 1.29).

• Настройте разрешения для Docker Compose. Пример команды:

  sudo chmod +x /usr/local/bin/docker-compose
  

• Установите Git.

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

Дистрибутив:

• Архив с дистрибутивом предоставляется клиенту при приобретении продукта через менеджера компании "Юниверс Дата". Образы также могут быть переданы по FTP или иным согласованным в договоре поставки способом.

• Заранее получите и скачайте файлы образов Docker с дистрибутивом продукта Юниверс (например, universe_mdm_ee_backend_docker_v6.13.tar, universe_mdm_ee_frontend_docker_v6.13.tar).

Установка

1. Скачайте и распакуйте из архива дистрибутива архивы образов Docker. Пример: universe_mdm_ee_backend_docker_v6.13.zip и universe_mdm_ee_frontend_docker_v6.13.zip. Внутри содержатся образы Docker с расширением .tar.

2. Распакуйте на сервер содержимое вышеуказанных архивов.

3. Запустите Docker.

4. Запустите загрузку образов в локальный Docker:

   docker load < /opt/universe_mdm_ee_backend_docker_v6.13.tar
   docker load < /opt/universe_mdm_ee_frontend_docker_v6.13.tar
   

5. Дождитесь завершения загрузки.

6. Создайте файлы конфигурации docker-compose.yaml, .env. Содержимое файлов см. ниже.

   • Расположение файлов на сервере может быть любым. Файлы конфигурации должны читаться через Docker compose.

7. Укажите имя образа и тег для файла .env. Используйте один из способов:

   • Измените имя и тег в параметрах BACKEND_IMAGE и FRONTEND_IMAGE файла .env. Сохраните изменения.

   • Используйте команду переименования образа. Пример:

     docker image tag repo.tddev.ru/unidata-mdm/backend:v6.3 universe_mdm_ee_backend:v6.13
     

8. Отредактируйте остальные требуемые параметры в файлах docker-compose.yaml, .env. Сохраните изменения.

9. Перейдите в каталог с конфигурационными файлами. Пример команды:

   cd universe-mdm-deploy
   

10. Для запуска системы используйте команду:

docker-compose up -d

11. При запуске интерфейса система потребует лицензию. Установите вашу лицензию.

По умолчанию пользовательский интерфейс доступен для просмотра на 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 содержится полный перечень доступных переменных.

1. Создайте файл docker-compose.yaml.

2. Создайте папку hunspell со словарями. См. также инструкцию по настройке библиотеки Hunspell.

3. Вы можете пересоздать 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 и конфигурационных файлов, адаптируя их под свои нужды.

Обязательные файлы конфигурации

Указанные ниже файлы должны быть созданы вручную.

Пример файла .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

Где BACKEND_IMAGE и FRONTEND_IMAGE: имена Docker-образов и теги версии. Тег указывается после двоеточия. Пример значений:

• BACKEND_IMAGE=universe_mdm_ee_backend:v6.13

• FRONTEND_IMAGE=universe_mdm_ee_frontend:v6.13