Подготовка окружения#

Подготовка окружения зависит от способа установки и описана в рамках выбранного способа установки.

Примечание

Перед началом подготовки убедитесь, что на хосте, с которого выполняется сборка дистрибутива, установлены следующие утилиты:

JDK. Рекомендуемая версия уточняется в разделе Системные требования;
unzip.

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

Подготовка элементов развертывания#

Corax поставляется в виде ZIP-архива, который разделен на:

архив с компонентами продукта в ZIP-формате с именем *-owned*.zip; содержит архивы с конфигурациями и бинарными артифактами компонентов;
архив с внешними opensource-зависимостями в ZIP-формате с именем *-party*.zip; основная часть — opensource-библиотеки;
архив с документацией в ZIP-формате с именем *-doc*.zip; основная часть — документация и метаинформация.

Чтобы получить самодостаточный дистрибутив, готовый к инсталляции и дальнейшему использованию на стороне потребителя, воспользуйтесь скриптом восстановления restore-distrib.sh, который находится либо внутри скаченного архива, либо доступен в личном кабинете пользователя в разделе «Дистрибутивы»:

Интерфейс пользователя

Info

KFK - код продукта;
x.y.z - версия;
b — номер сборки.

Важно

Для корректной работы скрипта запрещено изменять имена исходных архивов.

Распакуйте ZIP-архив с дистрибутивом продукта (в примере директория $HOME/corax-distrib/):

mkdir $HOME/corax-distrib
unzip $HOME/KFK-x.y.z-b-distrib.zip -d $HOME/corax-distrib/

Структура дистрибутива после распаковки:

├── KFK-x.y.z-b-cyclonedx-distrib.json           // Список всех зависимостей исходного кода программного продукта
├── KFK-x.y.z-b-owned-distrib.zip                // Дистрибутив продукта
├── KFK-x.y.z-b-owned.pom                        // Информация об артефакте KFK-x.y.z-b-owned-distrib.zip
├── KFK-x.y.z-b-party-distrib.zip                // Архив со сторонними зависимостями
├── KFK-x.y.z-b-party.pom                        // Информация об артефакте KFK-x.y.z-b-party-distrib.zip
├── KFK-doc-x.y.z-b-distrib.zip                  // Дистрибутив документации на программный продукт
├── KFK-doc-x.y.z-b.pom                          // Информация об артефакте KFK-doc-x.y.z-b_xx-distrib.zip
├── regid.2021-12.ru.sbertech_kfk-x.x.x.swidtag  // SWIDTAG-файл, содержащий данные, идентифицирующие программный продукт
├── assets.json                                  // Манифест ресурсов дистрибутива
└── restore-distrib.sh                           // Скрипт по формированию единого дистрибутива

Перейдите в директорию распаковки (в примере $HOME/corax-distrib/) и запустите скрипт ./restore-distrib.sh без параметров.
```
cd $HOME/corax-distrib
bash ./restore-distrib.sh
```
Скрипт:
- проведет проверку окружения на наличие необходимого программного обеспечения;
- соберет новый ZIP-архив с готовым к инсталляции и использованию дистрибутивом;
- удалит первоначальные ZIP-архивы, pom-файлы и swidtag-файл.
Если какого-то ПО не хватает, скрипт завершит работу с ошибкой.

Структура директории распаковки при успешной работе скрипта restore-distrib.sh:

├── KFK-x.y.z-b/                                 // Директория с подготовленным к ручной установке продуктом
├── KFK-x.y.z-b-cyclonedx-distrib.json           // Список всех зависимостей исходного кода программного продукта
├── KFK-x.y.z-b.zip                              // Архив с единым дистрибутивом продукта
├── assets.json                                  // Манифест ресурсов дистрибутива
├── regid.2021.12.ru.sbertech_kfk-x.x.x.swidtag  // SWIDTAG-файл, содержащий данные, идентифицирующие программный продукт
└── restore-distrib.sh                           // Скрипт по формированию единого дистрибутива

Для ручной установки продукта используйте директорию KFK-x.y.z-b.

Для автоматизированной установки перенесите и переименуйте полученный архив KFK-x.y.z-b.zip в директорию KFK-x.y.z-b/Corax-ansible-x.y.z-b/files/kafka-patched.zip, данный архив будет использоваться для автоматизированной установки:

cp $HOME/corax-distrib/KFK-x.y.z-b.zip $HOME/corax-distrib/KFK-x.y.z-b/Corax-ansible-x.y.z-b/files/kafka-patched.zip

Настройка окружения#

Настройка окружения зависит от способа установки и описана в рамках выбранного способа установки.

Выпуск и подготовка сертификатов#

Выпуск и подготовка сертификатов окружения зависит от способа установки и описана в рамках выбранного способа установки.