Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Платформа поставляется в виде образов 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.

    (warning) Версия должна быть не ниже 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

    (warning) Версия должна быть не ниже 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 (с которого должна работать платформа). Иначе запуск скрипта /wiki/spaces/v22/pages/2468732097 завершится с ошибкой.
Команда для ручной инициализации Docker Swarm:

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

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

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

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

Примечание

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

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

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

    (warning) Если предполагается установка платформы, используя Yandex Container Registry, копировать папку images дистрибутива не требуется.

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

    Image Removed

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

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

    Image Removed

    Запустите скрипт load_from_release_dockerhub.sh с правами суперпользователя:

    Image Removed

    -t 3.0 означает, что скрипту необходимо загрузить образы релиза версии 3.0.

    Запустите скрипт run.shс правами суперпользователя.
Выборка
hiddentrue

Платформа поставляется в виде образов 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.

    (warning) Версия должна быть не ниже 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

    (warning) Версия должна быть не ниже 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 (с которого должна работать платформа). Иначе запуск скрипта /wiki/spaces/v22/pages/2468732097 завершится с ошибкой.
Команда для ручной инициализации Docker Swarm:

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

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

  • Убедитесь, что команда docker запускается без Sudo, выполнив следующую команду:
    docker ps
    если команда не запускается, выполните следующую команду:

    Блок кода
    sudo usermod -aG docker $USER && \
    newgrp docker
  • Войдите в Yandex Container Registry:

    Блок кодаdocker login \          --username oauth \          --password <token> \          cr
    1. Загрузите образ platform-deployment.tar.gz в память Docker:

      Блок кода
      docker load < images/platform-deployment.tar.gz
    2. Запустите контейнер развёртки, который создаст скрипты в текущем каталоге:

      Блок кода
      docker run -it --rm -v $(pwd):/mnt/volume \
      cr.yandex/crpe1mi33uplrq7coc9d/visiology/release/platform-deployment:3.0 \
      ${UID} $(getent group ${USER} | awk -F: '{print $3}')
    3. Запустите скрипт load_images.sh:

      Блок кода
      ./load_images.sh

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

    Примечание

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

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

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

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

      Блок кода
      languagejson
      docker login \
               --username oauth \
               --password <token> \
               cr.yandex


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

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

      Блок кода
      docker pull cr.yandex/crpe1mi33uplrq7coc9d/visiology/release/platform-deployment:3.0
    Выполните еще одну командуЗапустить
    1. Запустите контейнер развёртки, который создаст скрипты в текущем каталоге:

      Блок кода
      docker run -it --rm -v $(pwd):/mnt/volume \
      cr.yandex/crpe1mi33uplrq7coc9d/visiology/release/platform-deployment:3.0 \
      ${UID} $(getent group ${USER} | awk -F: '{print $3}')
  • Появится папка visiology_3_0.

  • Зайдите в неё, выполнив команду:
    cd visiology_3_0

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

      Блок кода
      ./load_from_release_dockerhub.sh -t 3.0
    Запустить

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

    Примечание

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

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

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

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

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

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

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

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

    Блок кода
    ./run.sh --stop

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

    Блок кода
    ./run.sh -p <address> --https <yes | no> -v2 <yes | no>

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

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

    Блок кода
    ./run.sh -h

    Параметр

    Описание

    -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 и перезапустить платформу.

    Блок кода
    sed -i 's|USE_AUTHORIZATION=true|USE_AUTHORIZATION=false|g' run.sh

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

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

    На этой странице

    Оглавление

    🕑 Время чтения: 3 мин.


    Нужна дополнительная помощь?

    Свяжитесь с технической поддержкой.