Дистрибутив

Состав дистрибутива

Дистрибутив продукта включает:

инсталлятор для развертывания компонентов;
пакеты и файлы для установки основных модулей продукта;
пакеты для установки модуля координации (SaltStack);
пакет для установки системы fluent-bit;
документацию выпуска версии.

Инсталлятор

Инсталлятор включает файлы, содержащие:

сценарии развертывания модулей и компонентов (playbook);
инструкцию по работе с инсталлятором.

Пакеты и файлы для установки основных модулей продукта

Для установки основных модулей (бэкенд, фронтенд, модуль «Удаленный доступ») и компонентов продукта поставляются:

deb-пакеты, которые используются только при установке продукта на ОС Astra Linux:
- osmax-core — сборка бэкенда продукта, содержащая скомпилированный код для массовой установки ПО на устройствах и обработки полученных событий;
- osmax-provisioner — модуль, реализующий автоматическую установку операционной системы;
- osmax-webadmin — пользовательский интерфейс «Кабинет администратора»;
- osmax-appshop — пользовательский интерфейс «Магазин приложений»;
- osmax-ira-tigervnc — VNC-пакет для работы модуля «Удаленный доступ» на агентах (minions);
- osmax-ira-openssh — SSH-пакет для работы модуля «Удаленный доступ» на агентах (minions);
- osmax-ira-xrdp — XRDP-пакет для работы модуля «Удаленный доступ» на агентах (minions);
- osmax-ira-guacamole-server — сервер шлюза удаленного доступа;
- libosmaxvncserver — зависимый пакет компонента osmax-ira-guacamole-server;
- libosmaxfreerdp — зависимый пакет компонента osmax-ira-guacamole-server;
- osmax-ira-guacamole-client — WEB-клиент шлюза удаленного доступа;
rpm-пакеты, которые используются только при установке продукта на РЕД ОС:
- osmax-core — сборка бэкенда продукта, содержащая скомпилированный код для массовой установки ПО на устройствах и обработки полученных событий;
- osmax-provisioner — модуль, реализующий автоматическую установку операционной системы;
- osmax-webadmin — пользовательский интерфейс «Кабинет администратора»;
- osmax-app-shop — пользовательский интерфейс «Магазин приложений»;
wheel-пакет confluent_kafka для работы с Kafka Returner (используется только при установке продукта на РЕД ОС);
файлы:
- kafka_return_custom.py — файл с инструментом, который перенаправляет сообщения от агентов в топик Kafka;
- remove-denied-minions-keys.sls — файл состояния для SaltStack, который используется для обработки событий через Salt-Reactor;

Пакеты для установки модуля координации (SaltStack)

Для установки модуля координации (SaltStack) поставляются:

deb-пакеты, которые используются только при установке продукта на ОС Astra Linux:
- osmax-salt-formulas — пакет с формулами — специальными шаблонами для установки ПО на устройствах;
- salt-api — пакет, предоставляющий REST API для SaltStack;
- salt-common — пакет, содержащий библиотеки, необходимые для работы SaltStack;
- salt-master — пакет для установки сервера управления (master), который управляет всеми агентами (minions) в инфраструктуре;
- salt-minion — пакет для установки агентов (minions) на удаленных серверах;
- salt-cloud — пакет для управления облачными провайдерами (опциональный модуль);
- salt-dbg — пакет для отладки установки и поиска ошибок в настройках (опциональный модуль);
- salt-ssh — пакет для взаимодействия с агентами (minions) через протокол SSH, который может использоваться в качестве альтернативы, не требующей удаленного агента (опциональный модуль);
- salt-syndic — пакет, который используется для настройки среды с несколькими (masters) серверами управления и позволяет связывать их в единую сеть и управлять ими из одного места (опциональный модуль);
rpm-пакеты, которые используются только при установке продукта на РЕД ОС:
- osmax-salt-formulas — пакет с формулами — специальными шаблонами для установки ПО на устройствах;
- salt — пакет, содержащий библиотеки, необходимые для работы SaltStack;
- salt-master — пакет для установки сервера управления (master), который управляет всеми агентами (minions) в инфраструктуре;
- salt-api — пакет, предоставляющий REST API для SaltStack;
- salt-minion — пакет для установки агентов (minions) на удаленных серверах.

Пакет для установки системы Fluent Bit

Cистема Fluent Bit поставляется в виде deb-пакета fluent-bit и используется для сбора, преобразования и передачи лог-файлов аудита в систему-получатель клиента.

Документация выпуска версии

Документация выпуска версии включает файлы:

CHANGELOG.md — файл, содержащий журнал изменений проекта в виде упорядоченного списка версий продукта с датами их выхода и описанием;
osmax-doc — файлы в формате PDF с сопроводительной документацией, соответствующей версии продукта.

Формат именования пакетов

Имена пакетов с основными модулями продукта (osmax) и модулем fluent-bit формируются по шаблону:

<package_name>_<build_version>-<edition>_<architecture>.deb

Пример:

osmax-core_1.11.0_amd64.deb
fluent-bit_3.0.7_amd64.deb

<package_name>_<build_version>-<edition>_<architecture>.rpm

Пример:

osmax-core-1.11.0*.rpm

Где:

package_name — наименование модуля продукта;
build_version — версия пакета в соответствии с принципами семантического версионирования (мажорная_версия.минорная_версия.патч-версия);
edition — редакция дистрибутива;
architecture — архитектура;
package format — формат пакета; возможные варианты: .deb, rpm.

Имена пакетов модуля координации (salt) формируются по шаблону:

<package_name>_<build_version>_<architecture>.deb

Пример:

salt-common_3006.4_amd64.deb

<package_name>_<build_version>_<architecture>.rpm

Пример:

salt-3006.4-0.x86_64.rpm

Где:

package_name — наименование модуля продукта;
build_version — версия пакета в соответствии с принципами семантического версионирования (мажорная_версия.минорная_версия.патч-версия);
architecture — архитектура;
package format — формат пакета; возможные варианты: .deb, rpm.

Получение доступа к дистрибутиву

Доступ к дистрибутиву продукта можно получить одним из способов:

через apt/yum-репозиторий https://artifacts.inno.tech/repository/osmax-<edition>-<type>-packages, где:
- edition — редакция дистрибутива (astra/redos);
- type — тип репозитория (apt/yum).
в виде архивов в формате tar.gz, доступных для загрузки из репозитория https://artifacts.inno.tech/repository/osmax-<edition>-raw-packages, где edition — редакция дистрибутива.

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

Подключение apt-репозитория

Для установки deb-пакетов компонентов продукта и зависимостей из публичного apt-репозитория ГК «Иннотех» требуются:

ссылка на apt-репозиторий в формате https://artifacts.inno.tech/repository/osmax-<edition>-apt-packages;
файл с публичным ключом для доступа к apt-репозиторию;
учетная запись для доступа к apt-репозиторию.

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

Добавьте apt-репозиторий:

echo -e "deb https://artifacts.inno.tech/repository/osmax-astra-apt-packages/ 1.7_x86-64 main" | sudo tee /etc/apt/sources.list.d/innotech.list

См. инструкцию в официальной документации ОС Astra Linux.

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

echo -e "machine  artifacts.inno.tech login <repo_user> password <repo_password>" | sudo tee /etc/apt/auth.conf.d/innotech.conf

Скачайте файл публичного ключа из каталога keys:

curl -sSL -X GET -u "<repo_user>:<repo_password>"  https://artifacts.inno.tech/repository/osmax-astra-raw-packages/keys/osmax_astra_signing.key > osmax_astra_signing.key

Пример ключа

Добавьте ключ в систему:
```
sudo apt-key add osmax_astra_signing.key
```
Обновите пакеты с помощью стандартной команды:
```
sudo apt update -y
```

Подключение yum-репозитория

В текущей версии продукта дистрибутив для РЕД ОС поставляется в виде архивов для скачивания по ссылке вида:

https://artifacts.inno.tech/repository/osmax-redos-raw-packages/osmax/<version>/osmax-all-<version>.tar.gz

Скачивание из архива

Для скачивания архива с deb/rpm-пакетами требуются:

ссылка на репозиторий с архивом в формате https://artifacts.inno.tech/repository/osmax-<edition>-raw-packages;
учетная запись для доступа к репозиторию.

Архивы в репозитории сгруппированы по версиям.

Предоставляемые архивы:

архив с основными модулями (бэкенд, фронтенд, модуль «Удаленный доступ») и компонентами продукта;

Пример архива:
```
osmax-all-1.14.0.tar.gz
```
архив с модулем координации (SaltStack);

Пример архива:
```
salt_3006.4.tar.gz
```
архив с модулем fluent-bit.

Пример архива:
```
inno-fluent-bit-3.0.7.tar.gz
```

Чтобы скачать и распаковать архив, выполните действия:

Astra Linux
РЕД ОС

Скачайте архив с rpm-пакетами требуемых версий из предоставленного хранилища любым доступным способом.

В качестве примера ниже рассмотрен архив с основными модулями и компонентами продукта osmax-all-1.14.0.tar.gz.
(Опционально) убедитесь в целостности архива, сравнив его контрольные суммы с контрольными суммами в соответствующих файлах.

Пример команды:
```
shasum -a 512 -c osmax-all-1.14.0.tar.gz.sha512
osmax-all-1.14.0.tar.gz: OK
```
Перенесите скачанный архив на требуемый удаленный хост, выполнив команду scp (secure copy).

Пример команды:
```
scp osmax-all-1.13.0.tar.gz 10.6.32.218
```
Создайте временный каталог для распаковки и распакуйте архив.

Пример команд:
```
mkdir osmax
tar xvf osmax-all-1.13.0.tar.gz -C osmax
```

Скачайте архив требуемой версии из репозитория https://artifacts.inno.tech/repository/osmax-<edition>-raw-packages.

В качестве примера ниже рассмотрен архив с основными модулями и компонентами продукта osmax-all-1.14.0.tar.gz.
Распакуйте архив.

Пример команды:
```
tar xvf osmax-all-1.13.0.tar.gz
```
Перенесите скачанный архив на требуемый удаленный хост, выполнив команду scp (secure copy).

Пример команды:
```
scp ~/Downloads/osmax-*-1.14.0*.rpm  user@remote_host:/osmax/
```

Шаг 4 используется только при скачивании и распаковке архива с модулем координации (SaltStack) для последующей установки сервера управления (master).

Перенесите wheel-пакет для работы с Kafka Returner на машину, на которой будет запускаться сервер управления (master), выполнив команду scp (secure copy).

Пример команды:
```
scp ~/Downloads/salt_3006.4/confluent_kafka-*.whl user@remote_host:/salt-osmax/
```