Установка#

Матрица зависимостей компонентов#

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

Код компонента

GRAF

PLUG

GRIR

GRAF

—

Да

Опция

PLUG

Да

—

Нет

GRIR

Нет

Нет

—

  • Да — зависимость между модулями обязательна;

  • Нет — зависимость между модулями не предусмотрена;

  • Опция — подразумевает настройку интеграции между модулями в рамках определенных инсталляций.

Порядок установки#

  1. Шаг 1. Сборка RPM + ZIP для установки на VM (обязательный)

  2. Шаг 2. Настройка Deploy job для установки (обязательный)

  3. Шаг 3. Установка Продукта (обязательный)

  4. Шаг 4. Установка компонента GRAF (обязательный)

  5. Шаг 5. Установка компонента PLUG (обязательный)

  6. Шаг 6. Установка компонента GRIR (обязательный)

Шаг 1. Сборка RPM + ZIP для установки на VM (обязательный)#

Цель выполнения#

Целью данного этапа является подготовка дистрибутивов программного продукта Platform V View (PVV) в форматах RPM и ZIP, необходимых для последующего развертывания на целевых виртуальных машинах. Дистрибутивы содержат:

  • Бинарные файлы компонентов продукта (GRAF, PLUG, GRIR).

  • Скрипты инициализации, запуска и остановки сервисов.

  • Конфигурационные шаблоны для различных сред (dev, st, prod).

  • Метаданные для управления версиями и зависимостями.

Последовательность действий#

Для получения подробной информации по данному этапу обратитесь к инструкции Сборка RPM + ZIP

Шаг 2. Настройка Deploy job для установки (обязательный)#

Цель выполнения#

Целью данного этапа является настройка автоматизированного процесса развертывания продукта Platform V View (PVV) в целевой инфраструктуре с использованием Jenkins Pipeline. Настройка Deploy job позволяет исключить ручные ошибки при установке, обеспечить аудируемость процесса и поддерживать единый стандарт развёртывания на всех средах (dev, st, prod).

Последовательность действий#

Для получения подробной информации по данному этапу обратитесь к инструкции Настройка Deploy job для установки

Шаг 3 Установка продукта (обязательный)#

Цель выполнения#

Установка и настройка продукта PVV на виртуальной машине с использованием автоматизированного процесса развертывания через Jenkins Deploy Job.
Обеспечение запуска сервиса, корректной интеграции с зависимыми компонентами (IAM Proxy, SecMan, Pangolin) и доступности веб-интерфейса для последующей настройки и эксплуатации.

Последовательность действий#

Создание репозитория#

Необходимо создать репозиторий в системе контроля исходного кода на основе файлов, поставляемых в дистрибутиве (например, graf-bin-D-1.0.0-120-distrib.zip.1b4\package\scripts\deploy.zip\deploy) В корень репозитория выложить все с уровня /deploy и глубже по иерархии.

Создание Job типа Pipeline#

В интерфейсе Jenkins выполните создание Job типа Pipeline.

Выбор источника Jenkinsfile#

В качестве источника Jenkinsfile для Job необходимо указать \scripts\deploy.zip\deploy\dev-xxx\sbt_jenkinsfile_deploy_vm.

Добавление параметров в Properties Content#

В Properties Content добавить:

  • VIEW_ROLE_ID=//ID (соответствующий ROLE ID Secman, где хранится секрет для запуска и дальнейшей работы Platform V View);

  • VIEW_SECRET_ID=//ID (ID секрета);

  • VIEW_DEPLOY_USER=grafanase (пользователь для установки продукта).

Добавление Parameter#

Добавить Parameter:

  • Active Choice parameter (например, можно и String). SERVER1 (в котором необходимо указать целевые серверы для установки). Данный параметр должен совпадать с файлом sbt_inventory.yaml ключ children.servers.hosts.[].

  • String parameter. branch_service_pvv_build (ветка репозитория из шага 1, откуда будут браться параметры развертывания);

  • String parameter. DISTR_URL (URL zip дистрибутива);

  • String parameter. RPM_URL (URL rpm дистрибутива);

  • String parameter. BUILD_AGENT (имя лейбла Jenkins агента);

  • String parameter. EMAIL_LIST (список адресатов для получения уведомлений о результатах работы установочной job).

  • Groovy script. DEPLOY_ENV (параметр задает среду развертывания. например, st-xxx/dev-xxx в зависимости от того, какой хост указали для развертывания). Данный параметр должен совпадать с именем директории под /deploy/[***] репозитория шага 1.

Пример DEPLOY_ENV:

def dev_server="dev-xxx"
def st_server ="st-xxx"
if (SERVER1.equals("dev-grafаna-01.xxx")) {
return "<b>${dev_server}</b><input type=\"hidden\" name=\"value\" value=\"${dev_server}\" />"
}

Важно: В случае первичной установки на чистую БД необходимо согласно инструкции Настройки интеграции с Pangolin указывать в настройках подключения к БД пользователя - view_migrator, после выполнения миграции, рекомендуется выполнить переустановку сервиса с указанием в настройках подключение к БД пользователя - view_user

Внесение изменений в конфигурационные файлы компонентов#

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

Данная конфигурация хранится в репозитории вместе с Jenkinsfile для работы Job.

Сохранение Job#

Сохранить Job.

Добавление в раздел Jenkins «Credentials»#

Добавить в раздел Jenkins «Credentials»:

  • Тип: SSH Username with private. ID: key pvv_deployer. Предназначен для подключения по SSH и установки ПО на целевом хосте.

  • Тип: Username with password. ID: key db_pass. Предназначение - пользователь для подключения к БД продукта.

  • Тип: SSH Username with private. ID: works-pvv-sc. Предназначен для подключения к репозиторию source control от шага 1.

В случае необходимости можно изменить ID credentials.

Выбор системы для установки#

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

installation_deploy_job

Запуск установки#

Запустите процесс установки, нажав кнопку Собрать.

Шаг 4. Установка компонента GRAF (обязательный)#

Цель выполнения#

Целью установки компонента GRAF является развертывание основного модуля Platform V View (PVV).

Последовательность действий#

Для получения подробной информации по данному этапу обратитесь к соответствующей инструкции:

Шаг 5. Установка компонента PLUG (обязательный)#

Цель выполнения#

Целью установки компонента PLUG является расширение функциональности платформы Platform V View (PVV) за счёт подключения дополнительных модулей и интеграций.

Последовательность действий#

Для получения подробной информации по данному этапу обратитесь к соответствующей инструкции:

Шаг 6. Установка компонента GRIR (обязательный)#

Цель выполнения#

Целью установки компонента GRIR (Grafana Image Renderer) является обеспечение функциональности визуального рендеринга дашбордов в статические изображения.

Последовательность действий#

Для получения подробной информации по данному этапу обратитесь к соответствующей инструкции:

Проверка результата#

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