Разворачивание платформы

Owned by Эдуард Столяр, created
Last updated: янв. 19, 2023
3 min read

Платформа поставляется в виде образов Docker, содержащих в себе все компоненты с уже настроенным окружением и всеми внутренними зависимостями.

Примечание: Docker — программное обеспечение для автоматизации развёртывания и управления приложениями в среде виртуализации на уровне операционной системы. Суть и одно из предназначений Docker такое же, как и у виртуальных машин — это изоляция работы различных конфликтующих программ внутри одного сервера. Наглядно увидеть отличия между виртуальной машиной и контейнером можно, пройдя по ссылке: What is a Container?

Таким образом, установка платформы сводится к четырем шагам:

  1. Установка Docker Engine и Docker Compose внутри Ubuntu Linux.

  2. Загрузка образов в среду Docker.

  3. Подготовка скриптов.

  4. Запуск готовых Docker сервисов с компонентами платформы с помощью скрипта. В любом варианте развертывания используется режим Docker Swarm и Docker сервисы (а не просто контейнеры). Для подробной информации см. https://docs.docker.com/engine/swarm/key-concepts.

Установка и настройка Docker

  1. Установить Docker в соответствии с инструкцией: Install Docker Engine on Ubuntu.

    Версия должна быть не ниже 19.03.0.

  2. Выполнить настройку Docker по инструкции: Post-installation steps for Linux.

  3. Установить Docker Compose.
    Установка версии 1.29.2:

    sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose

    Версия должна быть не ниже 1.26.2 и не выше 1.29.2.

    Проверьте версию Docker. Проверить версию Docker можно следующими командами:

    docker --version docker-compose --version

    Для обновления Docker необходимо выполнить секцию Upgrade Docker Engine на странице Install Docker Engine on Ubuntu.

Если в системе присутствует два и более активных сетевых интерфейса (например, один для корпоративной внутренней сети, а второй для выхода в Интернет), то может потребоваться дополнительно инициализировать Docker Swarm и указать желаемый IP (с которого должна работать платформа).
Команда для ручной инициализации Docker Swarm:

docker swarm init --advertise-addr <ip address>

Установка через образы

Шаги установки

  1. Скопируйте дистрибутив платформы на сервер, сохраняя структуру вложенных элементов.

  2. На сервере перейдите в скопированную папку с дистрибутивом.

  3. Загрузите образ platform-deployment.tar.gz в память Docker:

    docker load < images/platform-deployment.tar.gz

  4. Запустите контейнер развёртки, который создаст скрипты в текущем каталоге:

  5. Запустите скрипт load_images.sh:

Установка через Yandex Container Registry

Данный вариант установки возможен только после предоставления доступа к регистру. Поэтому пользоваться в большинстве случаев нужно вариантом выше (когда образы уже скачаны вместе с дистрибутивом в папке images).

 Шаги установки

  1. Создайте новый каталог XXX (любое произвольное название) и перейдите в него - в нём появятся скрипты для запуска платформы.

  2. Войдите в Yandex Container Registry:


    где <token> -  токен, полученный из запроса https://oauth.yandex.ru/authorize?response_type=token&client_id=1a6990aa636648e9b2ef855fa7bec2fb

  3. Выполните следующую команду:

  4. Запустите контейнер развёртки, который создаст скрипты в текущем каталоге:

  5. Запустите скрипт load_from_release_dockerhub.sh:

Запуск платформы

В случае использования внешнего реверс-прокси в инфраструктуре клиента, перед первым запуском платформы необходимо закомментировать две строки в файле <distrib>/configs/nginx.conf :
#proxy_set_header X-Forwarded-Proto $scheme;
#proxy_set_header X-Scheme $scheme;

Для запуска платформы выполните следующие шаги:

  1. Запустите скрипт run.sh с указанием IP-адреса, где <IP> - IP-адрес или домен вашего сервера:
    ./run.sh -p <IP>

  2. Подождите, пока загрузится KeyCloak.

  3. Введите в адресной строке браузера следующий URL:
    <IP>/v3

  4. Произойдет редирект на KeyCloak.

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

логин – user
пароль – 123456.

Перезапуск платформы

Для перезапуска платформы необходимо сначала остановить платформу:

и затем запустить заново со всеми необходимыми параметрами:

Дополнительные параметры в run.sh

Список всех доступных параметров можно узнать, запустив следующую команду:

Параметр

Описание

Параметр

Описание

-d

Запуск в debug-режиме, отображает все запущенные команды.

-p <address>

Здесь <address> – адрес сервера, который будет использоваться пользователями платформы для доступа через браузер. Значение параметра может быть как IP-адресом, так и доменным именем сервера с установленной платформой, в зависимости от настроек сетевого окружения.

--https <yes | no>

Здесь параметр --https определяет, работает платформа со схемой HTTPS или HTTP. Для использования HTTPS необходимо указать значение параметра yes. Для использования схемы HTTP необходимо указать значение параметра no или не указывать параметр --https. Обратите внимание, что для работы платформы по HTTPS необходимо пройти шаги конфигурирования в разделе Работа по HTTPS. Одно лишь указание этого флага приведет к недоступности платформы и по HTTP, и по HTTPS.

-v2 <yes | no>

Этот параметр указывает на необходимость одновременной работы и версии 2.xx, и версии 3.0. Для запуска одновременной работы необходимо пройти шаги конфигурирования в разделе Одновременная работа версий 2.хх и 3.0 и указать значение параметра yes. Для запуска только версии 3.0 указать значение параметра no, или не указывать параметр.

--stop

Запуск команды с этим параметром останавливает всю платформу 3.0.

--force-pull

Принудительно выкачивает новые образы 3.0, если таковые имеются.

--force-regenerate-configs

Удаляет config-файлы и создаёт их заново.

Работа без авторизации

Для отключения авторизации необходимо в скрипте run.sh изменить значение параметра USE_AUTHORIZATION с true на false и перезапустить платформу.

Смотрите также

Системные требования