
### Развертывание с одним узлом (Single-Node Deployment)

- Разворачивается на одном сервере, что упрощает настройку и сокращает требования к инфраструктуре.

| Сервер    | Компоненты                                                                   |
| --------- | ---------------------------------------------------------------------------- |
| `Server1` | Zakroma-Archive, Nginx, Keycloak, PostgreSQL, Kafka и Kafka-UI (опционально) |

### Развертывание базового кластера (Multi-Node Deployment)

> [!info] В разработке
> Ansible роль и документация в разработке.
> Сейчас в отказоустойчивом режиме развёртывание возможно только с помощью k8s.



Варианты развертывания

1.4.0


## 1. Отключение SELinux

Убедитесь, что **SELinux** отключён.
На операционных системах ALT Server, RedOs, AlmaLinux и RHEL необходимо отключить SELinux.
Чтобы отключить SELinux:
Проверьте текущее состояние SELinux. Для этого выполните команду:

```bash  
sestatus
```  
Проверьте параметр SELinux status.
Если параметр имеет значение disabled, дальнейшие действия не требуются.
Откройте на редактирование файл /etc/selinux/config и измените значение параметра SELINUX на disabled.
Перезагрузите операционную систему.
Повторно проверьте состояние SELinux. Для этого выполните команду:
```bash  
sestatus
```  
Параметр SELinux status должен иметь значение disabled.
SELinux будет отключен.

## 2. Проверка и настройка DNS

1. Убедитесь, что все серверы могут правильно разрешать доменные имена (через DNS или `/etc/hosts`).
2. Создайте соответствующие **DNS A-записи**, указывающие на IP-адреса хостов, где будут развернуты сервисы:

Для **Single Node**:
```  
*.ps.zakroma.local            → хост(ы) с Zakroma-Storage
zakroma-gateway.zakroma.local → хост(ы) с Zakroma-Storage  
zakroma-admin.zakroma.local   → хост(ы) с Zakroma-Storage
archive.zakroma.local         → хост(ы) с Zakroma-Archive
keycloak.zakroma.local        → хост(ы) с Keycloak  
kafka.zakroma.local           → хост(ы) с Kafka (опционально)
kafka-ui.zakroma.local        → хост(ы) с Kafka-ui (опционально)
```  

В инструкции используется **пример домена** `zakroma.local`.    
Вы можете заменить его на собственную доменную зону, соответствующую вашей инфраструктуре (например, `zakroma.company.com` или `zakroma.internal`).
## 3. Подготовка сертификатов (TLS/SSL)

1. Сгенерируйте и/или получите сертификаты для следующих доменных имен:

Для **Single Node**:
```  
*.ps.zakroma.local  
zakroma-gateway.zakroma.local  
zakroma-admin.zakroma.local
archive.zakroma.local  
keycloak.zakroma.local
kafka-ui.zakroma.local (опционально)
```  

Эти сертификаты будут использоваться для безопасного доступа к Zakroma и Keycloak по HTTPS.
## 4. Подготовка для работы с Ansible

1. Проверьте, что доступно **SSH-подключение** к каждому хосту.
2. Убедитесь, что пользователь имеет привилегированный (sudo) доступ.
3. Установите или обновите **Ansible** до версии **2.15.0** или выше.

## 5. Настройка PostgreSQL

Настройте PostgreSQL согласно [инструкции](https://zakroma.ru/knowledgeBase/devops/article/nastrojka-postgre-sql?version=Закрома.Архив).

## 6. Настройка Keycloak

Настройте Keycloak согласно [инструкции](https://zakroma.ru/knowledgeBase/devops/article/keycloak?version=Закрома.Хранение).

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


## Компоненты системы

| Компонент                 | Описание                                                                                                              |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Zakroma-Archive           | Основное пакет приложения **Закрома.Архив**.                                                                          |
| Keycloak                  | Система управления аутентификацией и авторизацией (используется для Admin UI и доступа к Zakroma).                    |
| Nginx                     | Proxy-сервер, выступающий в качестве фронтенда для Zakroma-Archive.                                                   |
| PostgreSQL                | СУБД для метаданных и Keycloak.                                                                                       |
| Kafka (опционально)       | Система обмена сообщениями, используемая сервисами Zakroma (требуется для различных служебных операций, опционально). |
| Kafka-UI<br>(опционально) | Интерфейс управления и мониторинга Kafka-кластером через веб-приложение.                                              |

## Компоненты, устанавливаемые с помощью Ansible ролей

| Название        |                                                Поддерживаемые версии                                                |
| --------------- | :-----------------------------------------------------------------------------------------------------------------: |
| Zakroma-Archive |                                                        1.4.0                                                        |
| Keycloak        |                                                         26                                                          |
| Nginx           | в зависимости от дистрибутива Linux <br>(устанавливается из стандартных репозиториев хостовой операционной системы) |
| Java            | в зависимости от дистрибутива Linux <br>(устанавливается из стандартных репозиториев хостовой операционной системы) |
| Kafka           |                                                        3.8.1                                                        |
| Kafka-UI        |                                                        0.7.2                                                        |


## Поддерживаемые дистрибутивы Linux

| Название   | Поддерживаемые версии |
|------------|-----------------------|
| Debian     | 10, 11, 12            |
| Ubuntu     | 20, 22, 24            |
| AlmaLinux  | 8, 9                  |
| RedOs      | 7, 8                  |
| RHEL       | 8, 9                  |
| ALT Server | 10.4 (Mendelevium)    |

### Структура дистрибутива

Дистрибутив поставляется архивом вида`zakroma-roles-<ВЕРСИЯ_РЕЛИЗА_АРХИВА_С_ANSIBLE_РОЛЯМИ>.tar.gz`

```yaml  
.
├── ansible.cfg
├── CHANGELOG.md
├── collections
│   └── ansible_collections
├── files
│   └── realm.json
├── inventories
│   └── single-node
│       ├── group_vars
│       │   ├── certificates.yml
│       │   ├── java.yml
│       │   ├── kafka-ui-nginx.yml
│       │   ├── kafka-ui.yml
│       │   ├── kafka.yml
│       │   ├── keycloak.yml
│       │   ├── zakroma-archive.yml
│       │   └── zakroma-storage-nginx.yml
│       └── hosts
├── playbooks
│   ├── sample-play-copy-certificates.yml
│   ├── sample-play-java.yml
│   ├── sample-play-kafka-ui-nginx.yml
│   ├── sample-play-kafka-ui.yml
│   ├── sample-play-kafka.yml
│   ├── sample-play-keycloak-copy-realm.yml
│   ├── sample-play-keycloak.yml
│   ├── sample-play-zakroma-archive.yml
│   ├── sample-play-copy-licence-file.yaml
│   └── sample-play-zakroma-storage-nginx.yml
├── README.md
└── roles
```

***

- **ansible.cfg**  
  Файл конфигурации Ansible, в котором задаются параметры работы (например, пути к инвентарям, настройки подключения,
  параметры логирования и т.д.).
- **CHANGELOG.md**  
  Журнал изменений проекта. Здесь фиксируются версии, внесённые правки, улучшения и исправления ошибок.
- **collections/**  
  Каталог, содержащий Ansible collections – наборы ролей, плагинов и модулей, объединённых в пакеты для удобного
  повторного использования и распространения.
- **files/realm.json**  
  JSON-файл, содержащий сконфигурированный REALM для Keycloak.
- **inventories/**  
  Каталог с инвентарями Ansible, разделёнными по различным сценариям развёртывания:
    - **single-node/**  
      Инвентарь для развёртывания на одном узле:
        - **group_vars/** – файлы с переменными для одиночного узла. Отличительной особенностью является наличие файла *
          *zakroma-zds-fs.yml** (нижний слой хранения без Erasure Coding).
        - **hosts** – файл с описанием единственного узла.
- **playbooks/**  
  Каталог с playbook'ов, необходимых для применение ролей или выполнение конкретных задач:
    - **sample-play-copy-licence-file.yaml** – playbook для копирования файла лицензии.
    - **sample-play-copy-certificates.yml** – playbook для копирования сертификатов.
    - **sample-play-java.yml** – playbook для установки Java.
    - **sample-play-kafka-ui-nginx.yml** – playbook для установки и конфигурирования Nginx для Kafka-UI.
    - **sample-play-kafka-ui.yml** – playbook для установки и конфигурирования Kafka UI.
    - **sample-play-kafka.yml** – playbook для установки и конфигурирования Kafka.
    - **sample-play-keycloak-copy-realm.yml** – playbook для копирования realm-конфигурации в Keycloak.
    - **sample-play-keycloak.yml** – playbook для установки и конфигурирования Keycloak.
    - **sample-play-zakroma-archive.yml** – playbook для установки и конфигурирования Zakroma-Archive.
    - **sample-play-zakroma-storage-nginx.yml** – playbook для установки и конфигурирования Nginx для Zakroma-Storage.
    - **sample-play-zakroma-storage.yml** – playbook для установки и конфигурирования Zakroma-Storage.
    - **sample-play-zakroma-zds-fs.yml** – playbook для установки и конфигурирования Zakroma-ZDS в режиме FS (без
      Erasure Coding).
- **README.md**  
  Основной файл с описанием проекта, содержащий обзор, инструкции по установке, использованию и общую информацию о проекте.
- **roles/**  
  Каталог, где располагаются Ansible роли.
