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

Внимание

Дисклеймер.

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

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

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

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

Примечание

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

Предупреждение

В Юниверс MDM версии 6.11 было осуществлено обновление PostgreSQL до версии 16.3, в связи с этим теперь требуется обязательная установка расширения TimescaleDB для корректной работы с большими объемами данных. Перед установкой рекомендуется проверить совместимость вашей версии PostgreSQL и версии TimescaleDB.

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

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

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

  • Установите Docker через официальный репозиторий. Документацию см. по ссылке https://docs.docker.com/

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

  • Настройте разрешения для Docker Compose. Пример команды: sudo chmod +x /usr/local/bin/docker-compose

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

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

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

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

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

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

  1. Убедитесь, что ссылка на репозиторий с дистрибутивом вашего продукта в наличии. О получении ссылки см. выше.

  2. Клонируйте репозиторий из Gitlab или Docker. Пример команды:

    git clone [your-link-universe-platform-deploy.git]

  3. Перейдите в каталог с проектом. Пример команды:

    cd universe-platform-deploy

  4. Авторизуйтесь в репозитории с помощью команды (используя логин / пароль):

    sudo docker login repo/universe-mdm-deploy

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

    docker-compose up -d

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

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

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

  1. Используйте базовый образ PostgreSQL версии 16.3:

FROM postgres:16.3

  1. Установите необходимые пакеты:

RUN apt-get update && apt-get install -y --no-install-recommends wget gnupg lsb-release software-properties-common ca-certificates

  1. Добавьте ключ GPG и репозиторий TimescaleDB без использования apt-key:

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

  1. Установите TimescaleDB:

RUN apt-get update && apt-get install -y --no-install-recommends timescaledb-2-postgresql-16

  1. Сконфигурируйте PostgreSQL для загрузки расширения TimescaleDB:

RUN echo "shared_preload_libraries = 'timescaledb'" >> /usr/share/postgresql/postgresql.conf.sample

  1. Очистите кэш apt, чтобы уменьшить размер образа:

RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*

Пользовательская установка с 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:
  jacoco:
    image: docker.universe-data.ru/mirror/postgres16.3-tsdb2.15.2
    profiles: ["jacoco"]
    volumes:
      - jacoco:/jacoco:ro

  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
      - ${JACOCO_AGENT_PORT:-6300}:6300
    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_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:-}
    volumes:
      - jacoco:/jacoco:ro
    depends_on:
      postgres-mdm:
        condition: service_healthy
      opensearch-mdm:
        condition: service_healthy

  postgres-mdm:
      image: postgres:16.3 # Обновите версию образа
      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_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
  jacoco:
    driver: local

networks:
  mdm_network:
    driver: bridge

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

Совет

Имена параметров могут различаться в зависимости от редакции (SE/EE/CE), но должны совпадать с параметрами, указанными в файле docker-compose.yaml

  • 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 - параметры, отвечающие за восстановление пароля.

  • CORE_SECURITY_TOKEN_MANUAL_PROLONGATION_ENABLED - параметр, отвечающий за продление сессии пользователя.

  • Группа параметров nginx.conf:

    • BACKEND_ADDRESS - значение берется из одноименной секции в файле docker-compose.yaml - в примере используется значение mdm.

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

BACKEND_IMAGE=docker.universe-data.ru/unidata-ee/backend:release-6-11-f428d71f
FRONTEND_IMAGE=docker.universe-data.ru/unidata-ee/frontend:release-6-11-99b3156c

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