## Набор ролей для установки Zakroma Storage, Zakroma ZDS, Keycloak и Nginx

Данная инструкция поможет развернуть объектное хранилище ЗАКРОМА с помощью Ansible-ролей.
В архиве находится 5 ролей:
```yaml
- certificates      (копирование сертификатов на целевые хосты).
- nginx             (установка и конфигурирование nginx).
- keycloak          (установка и конфигурирование keycloak).
- zakroma-storage   (установка и конфигурирование Закрома Storage, основные сервисы).
- zakroma-zds       (установка и конфигурирование Закрома ZDS, это сервис для подключения нижнего слоя хранения).
```

## Структура 
```yaml
.
├── ansible.cfg
├── collections
│   └── ansible_collections
├── files
│   ├── grafana-dashboard-s3-metrics.json
│   ├── grafana-dashboard-zakroma-services.json
│   └── realm.json
├── group_vars
│   ├── certificates.yml
│   ├── keycloak.yml
│   ├── zakroma-storage-nginx.yml
│   ├── zakroma-storage.yml
│   ├── zakroma-zds-ec.yml
│   └── zakroma-zds-fs.yml
├── hosts-example
├── README.md
├── roles
│   ├── certificates
│   ├── keycloak
│   ├── nginx
│   ├── zakroma-storage
│   └── zakroma-zds
├── sample-play-copy-certificates.yml
├── sample-play-keycloak-copy-realm.yml
├── sample-play-keycloak.yml
├── sample-play-zakroma-storage-nginx.yml
├── sample-play-zakroma-storage.yml
├── sample-play-zakroma-zds-ec.yml
└── sample-play-zakroma-zds-fs.yml
```

## Требования

```yaml
- ssh подключение к хостам.
- пользователь с привилегированным доступом.
- ansible > 2.15.0.
```

## Пререквизиты
- Создать сертификаты на следующие доменные имена (пример FQDN - zakroma.local):
```yaml
*.ps.*FQDN*
zakroma-gateway.*FQDN*  
zakroma-admin.*FQDN*
keycloak.*FQDN*
```
- Создать DNS A-записи для вышеуказанных доменных имен:
```txt
*.ps.*FQDN*            - на хосты c zakroma-storage (нужна для для доступа к s3-endpoint'у по path-style)
zakroma-gateway.*FQDN* - на хосты c zakroma-storage
zakroma-admin.*FQDN*   - на хосты c zakroma-storage
keycloak.*FQDN*        - на хосты c keycloak 
```
- Требуется настройка PostgreSQL, согласно [инструкции](https://zakroma.ru/knowledgeBase/storage/article/nastrojka-postgre-sql?version=2.2).
- При установке Keycloak ansible ролью - установить на целевой хост Java 17+ 
- Выполнить монтирование дисковой емкости для последующего использования в качестве нижнего слоя хранения ZDS.
  Точки монтирования должны быть добавлены в /etc/fstab используя UUID. Рекомендуемые параметры дисковых устройств для ZDS:
  - ФС: XFS,EXT4
  - Использование групп томов (Volume Groups): Рекомендуется

## Установка Storage (Закрома.Хранение)

### 1. Получить и распаковать архив с Ansible ролями
```bash
tar -xvf zakroma-roles.tar 
```
Перейти в директорию с ролями
```bash
cd zakroma-roles
```

### 2. Создать inventory, включающий хостнейм в соответствующих хост-группах, как пример можно использовать файл `hosts-example`
```yaml
[certificates]
rutherford-1 ansible_host=192.168.1.1
rutherford-2 ansible_host=192.168.1.2
rutherford-3 ansible_host=192.168.1.3
rutherford-4 ansible_host=192.168.1.4

[keycloak]
rutherford-1 ansible_host=192.168.1.1

[zakroma-storage-nginx]
rutherford-2 ansible_host=192.168.1.2
rutherford-3 ansible_host=192.168.1.3
rutherford-4 ansible_host=192.168.1.4

[zakroma-storage]
rutherford-2 ansible_host=192.168.1.2
rutherford-3 ansible_host=192.168.1.3
rutherford-4 ansible_host=192.168.1.4

[zakroma-zds-ec]
rutherford-6 ansible_host=192.168.1.6
rutherford-7 ansible_host=192.168.1.7
rutherford-8 ansible_host=192.168.1.8

[zakroma-zds-fs]
rutherford-5 ansible_host=192.168.1.5
```

### 3. Копирование сертификатов на целевые хосты (при необходимости их копирования)

- Необходимо переопределить переменные для роли "certificates" и групп хостов "certificates". Пример: ./group_vars/certificates.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-copy-certificates.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

### 4. Установка Keycloak

- Необходимо переопределить переменные для роли "keycloak" и групп хостов "keycloak". Пример: ./group_vars/keycloak.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-keycloak.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

- После установки keycloak необходимо сконфигурировать REALM по [инструкции](https://zakroma.ru/knowledgeBase/storage/article/keycloack?version=2.2) или воспользоваться плейбуком, который сделает импорт готового REALM
 ```bash
ansible-playbook -i hosts-example sample-play-keycloak-copy-realm.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

### 5. Установка Zakroma Storage
- Необходимо переопределить переменные для роли "zakroma-storage" и групп хостов "zakroma-storage". Пример: ./group_vars/zakroma-storage.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-zakroma-storage.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

### 6. Установка Nginx (на хосты с Zakroma Storage)
- Необходимо переопределить переменные для роли "nginx" и групп хостов "zakroma-storage-nginx". Пример: ./group_vars/zakroma-storage-nginx.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-zakroma-storage-nginx.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

- Проверить доступность Web интерфейса:
  * Admin UI:
  * Url - `https://zakroma-admin.*FQDN*`
  * Username - `zakromaadmin`
  * Password - Какой вы указали на этапе создания пользователя `zakromaadmin` в keycloak. Если был импорт готового REALM, то пароль - 'zakromaadmin'

## Установка ZDS
### 7. Установка Zakroma ZDS в режиме EC (Erasure coding, минимум 3 хоста) (нижний слой хранения)
- Необходимо переопределить переменные для роли "zakroma-zds-ec" и групп хостов "zakroma-zds-ec". Пример: ./group_vars/zakroma-storage-ec.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-zakroma-zds-ec.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

### 8. Установка Zakroma ZDS в режиме FS (без избыточности, 1 хост) (опционально) (нижний слой хранения)
- Необходимо переопределить переменные для роли "zakroma-zds-fs" и групп хостов "zakroma-zds-fs". Пример: ./group_vars/zakroma-storage-fs.yml
- Запустить playbook:
 ```bash
ansible-playbook -i hosts-example sample-play-zakroma-zds-fs.yml -u <ssh-username> --private-key <path_to_ssh_key>
```

## Подключение к S3
* Protocol: `https/http`
* Host: `<workspace_name>.ps.*FQDN*`
* Signature version: `V4 sign`

где <workspace_name> - имя рабочей области, где находятся бакеты, например `test`.

Установка через ansible

Бинарные пакеты

Расчет требований к инфраструктуре

Требования

Первые шаги в приложении

Начало работы

С чего начать

Подготовка инфраструктуры

Установка helm-чартами

Контейнеры

Настройка Zakroma.Storage (ZDS)

Настройка Keycloak

Настройка Virtual-hosted–style

Настройка PostgreSQL

Self signed ssl certificate

Метрики

Окружение

Установка

Описание работы страницы с операциями

Операции

Отслеживание задач и статуса системы

Мониторинг

CLI (Command Line Interface, zcli)

CORS

Подключение ресурса хранения

Хранилища

Просмотр бакета

Управление рабочими областями

Рабочие области

Как создавать и настраивать бакеты

Бакет (bucket)

Публичные бакеты

Шардирование

Описание типов хранилищ

Тип Хранилища

Удаление бакета

Версионирование бакета

Версионирование

Настройка хранения

Политики доступа предназначены для создания правил разграничения доступа пользователей к операциям S3.

Политики доступа

Редактирование информации о пользователях

Пользователи

Роли

Администраторы workspace/bucket

Профиль пользователя

Управление ключами доступа

Фильтрация по IP

Группы пользователей

Доступ

Принцип работы кластерного режима

Мультикластер

Включение кластерного режима

Добавление кластера

Управление

Механизм оповещения других систем о событиях в хранилище.

Webhooks

Как подключить хранилище с уже имеющимися данными в нем

Подключение хранилища с данными

Путь хранения объектов бакета на подключенном хранилище

Формирование пути хранения данных

Правила жизненного цикла данных

Жизненный цикл

Политика Расширение позволяет объединить несколько ресурсов хранения

Расширение

Политика Зеркалирование позволяет настроить синхронную и асинхронную репликацию бакета

Зеркалирование

Политики хранения

Перенос данных бакета из одного Хранилища в другое

Миграция данных

Настройка подключения к Закрома Хранение

Подключение к Закрома.Хранение

Таблица поддерживаемых методов AWS S3

Поддержка методов AWS S3

Описание возможностей масштабирования объёма хранения кластера