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

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

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

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-файл, содержащий данные, идентифицирующие программный продукт
└── 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.zip      // Архив с единым дистрибутивом продукта
├── KFK-x.y.z-b          // Директория с подготовленным к ручной установке продуктом
└── restore-distrib.sh   // Скрипт по формированию единого дистрибутива

Внимание

В данном сценарии предполагается наличие отдельно скаченного скрипта restore-distrib.sh, соответствующего версии дистрибутива.

Важно

В данном сценарии каталог для ручной установки дистрибутива автоматически не создается!

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

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

├── KFK-x.y.z-b-distrib.zip  // Архив с исходным дистрибутивом продукта
├── KFK-x.y.z-b.zip          // Архив с единым дистрибутивом продукта
├── KFK-x.y.z-b              // Директория с подготовленным к ручной установке продуктом
└── restore-distrib.sh       // Скрипт по формированию единого дистрибутива

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

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

Создайте директорию, которая будет использоваться для автоматизированной установки (в примере $HOME/corax/):
```
mkdir $HOME/corax
```
В созданную директорию скопируйте директорию kfka-deploy-x.y.z-distrib из директории с подготовленным к дальнейшим действиям дистрибутивом:
```
cp -r $HOME/corax-distrib/KFK-x.y.z-b/kfka-deploy-x.y.z-distrib/* $HOME/corax/
```
Разархивируйте единый дистрибутив продукта для получения архива KFK-x.y.z-b-distrib.zip:
```
unzip -r $HOME/corax-distrib/KFK-x.y.z-b.zip
```
В директорию $HOME/corax/files скопируйте архив архива KFK-x.y.z-b-distrib.zip из шага 3:
```
cp $HOME/corax-distrib/KFK-x.y.z-b-distrib.zip $HOME/corax/files/
```

Каталог $HOME/corax/ подготовлен к автоматизированной установке.

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

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

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

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