Установка PREM#

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

Целью данной инструкции «Установка PREM» является описание последовательных шагов по развертыванию компонента PREM. Выполнение инструкции обеспечивает корректную установку и настройку сервисов «Calculator» и «Adapter», включая сборку и публикацию контейнерных образов, а также развертывание компонентов с помощью Helm-чарта.

Состав дистрибутива компонента PREM#

Перед установкой убедитесь, что состав дистрибутива компонента PREM корректен и представлен в полном объеме.

Компонент PREM предоставляет 2 архива (бинарные файлы и конфигурации), а также дополнительные файлы:

prem-bin-{version}-{build}-distrib#

Элемент дистрибутива

Описание

./package/bh/prem-calculator

Бинарные файлы приложения «Calculator»

./package/bh/prem-adapter

Бинарные файлы приложения «Adapter»

./package/docker/prem-calculator/Dockerfile

Dockerfile для сборки приложения «Calculator»

./package/docker/prem-adapter/Dockerfile

Dockerfile для сборки приложения «Adapter»

prem-cfg-{version}-{build}-distrib#

Конфигурации для установки.

Элемент дистрибутива

Описание

./package/conf/helm/application/prem/*

Конфигурации развертывавния компонента

prem-bin-{version}-{build}–cyclonedx-distrib.json#

В данном файле находится спецификация программного обеспечения SBOM (Software Bill Of Materials) — это список всех open source и других сторонних компонент, использующихся в кодовой базе программного продукта.

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

С помощью SBOM вы можете просмотреть версии сборки, номера выпусков компонентов программного обеспечения и решить, продолжать их использование или нет. Это необходимо во избежание проблем с безопасностью в цепочках зависимостей. Поэтому, если в одной из библиотек обнаруживается проблема, вам необходимо знать, уязвимо ли приложение в целом.

CycloneDX — это стандарт SBOM от фонда OWASP, разработанный для контекстов безопасности приложений и анализа компонентов цепочки поставок, обеспечивающий инвентаризацию всех компонентов программного обеспечения как собственных, так и сторонних производителей.

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

  1. Шаг 1. Сборка и установка бинарных файлов

  2. Шаг 2. Развертывание сервиса c помощью Helm чарта

Примечание: в виду отсутствия ролевой модели для компонента PREM отсутсвует необходимость в ее установке соотвественно.

Шаг 1. Сборка и установка бинарных файлов#

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

Цель выполнения шага - подготовить бинарные файлы приложения, собрать их в контейнерный образ (image) и интегрировать его в конфигурации установки, чтобы обеспечить корректную работу системы.

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

  1. Используйте инструменты сборки, чтобы создать исполняемые файлы или артефакты.

  2. Соберите Docker-образ, включающий бинарные файлы.

Чтобы собрать Docker-образ для prem-calculator введите следующую команду:

   docker build -t <ваш registry>/<ваш путь>/prem-calculator:latest -f package/docker/prem-calculator/Dockerfile . --build-arg=<базовый образ>

Далее отправьте Docker-образ для prem-calculator в registry, для этого введите следующую команду:

   docker push <ваш registry>/<ваш путь>/prem-calculator:latest

Чтобы собрать Docker-образ для prem-adapter введите следующую команду:

   docker build -t <ваш registry>/<ваш путь>/prem-adapter:latest -f package/docker/prem-adapter/Dockerfile . --build-arg=<базовый образ>

Далее отправьте Docker-образ для prem-adapter в registry, для этого введите следующую команду:

   docker push <ваш registry>/<ваш путь>/prem-adapter:latest

  1. Обновите конфигурационные файлы (например, Helm-chart, Kubernetes Deployment), указав новый образ:

image:
  repository: <ваш registry>/<имя вашего образа>
  tag: latest

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

Если все выполнено верно, система будет использовать актуальный образ с собранными бинарными файлами, и конфигурации установки будут работать без ошибок.

Шаг 2. Развертывание сервисов c помощью Helm чарта#

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

Цель выполнения шага - развернуть сервисы с использованием Helm-чарта, используя подготовленный Docker-образ с бинарными файлами, чтобы обеспечить корректную работу системы в кластере Kubernetes.

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

  1. Убедитесь, что Helm-чарт существует и содержит конфигурации для развертывания сервисов.

  2. Выполните команду для установки чарта в кластер Kubernetes:

   helm install <ваш релиз> ./path/to/chart --namespace <название вашего namespace>

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

Если все выполнено верно:

  • Helm-релиз будет отображаться в списке (helm list).

  • Все поды будут работать без ошибок.

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

Корректным результатом проверки установки PREM является соотвествие успешным проверкам в шагах:

  • Сборка и установка бинарных файлов.

  • Развертывание сервисов c помощью Helm чарта.