CLI (Command Line Interface, zcli)

Управление

## Монитор

Раздел **"Монитор"** предназначен для отображения состояния ключевых компонентов системы. Проверка состояния выполняется с помощью набора **модулей**, каждый из которых отслеживает определённый функциональный блок (например, хранилища или фоновые задачи).
## Назначение модулей

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

- 🔴 **Ошибки** (`errors`) — критические проблемы;
- 🟡 **Предупреждения** (`warnings`) — потенциальные риски.
  
Информация визуализируется в интерфейсе через цветовые индикаторы, а также текстовые сообщения.
## Общий вид страницы

![image](https://storage.yandexcloud.net/zakroma-ru/media/be2eecacdcb31995692523144735aa4a.png)

На странице **Монитор** модули отображаются в виде отдельных карточек. Каждая карточка включает базовую информацию:

- Название модуля;
- Основные числовые показатели (например, количество хранилищ, недоступных шардов и т.д.);
- Иконку статуса (в случае наличия ошибок или предупреждений).
## Просмотр подробной информации 

![image](https://storage.yandexcloud.net/zakroma-ru/media/0c34c69590465b79770bbdf7747cfec3.png)

Для получения деталей по модулю:

1. Нажмите на карточку модуля (например, **Хранилища**).
2. В правой части экрана откроется блок **Информация о модуле**, где отображаются:

- Название модуля;
- Дата последней проверки;
- Период проверки — частота автоматического запуска проверок (например, «раз в 120 секунд»);
- Список ошибок и предупреждений (раскрашены в соответствии с критичностью);
- Специфичные параметры (кастомные поля).

### Пример ошибок и предупреждений

- Хранилище `Storage1` недоступно
- Осталось менее 15 % свободного места на хранилище `zds-fs`
- В ZDS хранилище активны 2 ноды из 3

![image](https://storage.yandexcloud.net/zakroma-ru/media/8d8d5168ca5c6577b0795582c6133689.png)
## Информационные поля

 Каждый модуль показывает собственные информационные поля — например, общее количество объектов, количество недоступных элементов и т.п. Эти поля представлены в формате `Название - Значение` и заполняются проверяемым модулем системы.

  Их набор зависит от модуля и может отличаться.
## Общесистемные параметры

![image](https://storage.yandexcloud.net/zakroma-ru/media/df0396eaa8be149165ee3d6634c33acb.png)

В нижней части экрана отображаются базовые общесистемные параметры (например, версия системы, количество хранилищ и т.д.).

- Версия системы;
- Количество рабочих областей;
- Общее число хранилищ, buckets и шардов;
- Состояние мультикластера;
- Статус лицензии.

> Эти данные автоматически формируются системой и, при необходимости, могут быть получены программно по API (`GET /monitor/system-params`).

## Запуск проверки вручную

![image](https://storage.yandexcloud.net/zakroma-ru/media/f84a0f0697491369edabe3444ba9d32a.png)

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

1. Нажмите кнопку **Запустить проверку** в правом верхнем углу.
2. В появившемся диалоговом окне подтвердите запуск.

> Это действие инициирует внеплановую проверку всех активных модулей и обновляет данные в интерфейсе. 
## Переход к мониторингу Grafana

В правом верхнем углу страницы расположена кнопка **Мониторинг Grafana**. При нажатии на нее открывается внешний дашборд с графиками и визуализациями текущего состояния системы на платформе **Grafana**.

> 📌 Обратите внимание: при переходе может потребоваться **авторизация** в Grafana. Используйте учётные данные, предоставленные администратором системы.

---

### Таблица модулей мониторинга

| Модуль(и)                                                                                                | Назначение проверки                                        | Ошибки и предупреждения                                                                                                                 | Ключевые показатели                                           |
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| **Хранилища**                                                                                            | Проверка доступности и свободного места                    | 🔴 Недоступное хранилище, 🟡 Мало свободного места                                                                                      | Всего хранилищ, Недоступно                                    |
| **Шарды**                                                                                                | Проверка доступности воркеров и скорости                   | 🔴 Недоступный шард, 🟡 Мало шардов                                                                                                     | Всего воркеров, Недоступно                                    |
| **Фоновые задачи**                                                                                       | Статистика по задачам системы.<br>Анализ задач с ошибками. | Информативный модуль: показывает общее количество задач и число зависших.<br>`<new_errors>` новых ошибок найдено при последней проверке | Ожидают обработки, Зависшие задачи.<br>Всего задач с ошибками |


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

Мониторинг

## Операции

На странице `ОПЕРАЦИИ` доступны данные о действиях пользователей (так называемый "Аудит лог"), как администраторов, так и пользователей S3 API.

>[!warning] Доступность пункта
>Меню операции доступно в интерфейсе только в случае записи Аудит лога в базу данных. Если выбрана запись в файл, то анализ Аудит лога возможен только сторонними инструментами.


На странице доступна фильтрация и список всех совершенных операций. В списке операций можно увидеть следующую информацию:
![image](https://storage.yandexcloud.net/zakroma-ru/media/0487b9b560e69876aebfa18e00349485.png)

- Дата - дата и время совершения операции.
- [Пользователь](https://zakroma.ru/knowledgeBase/storage/article/polzovateli?version=2.6) - логин пользователя, совершившего операцию.
- Операция - название совершенной пользователем операции
- [Рабочая область](https://zakroma.ru/knowledgeBase/storage/article/rabochie-oblasti?version=2.6) - название рабочей области, в которой была совершена операция.
- [Bucket](https://zakroma.ru/knowledgeBase/storage/article/buckets?version=2.6) - название бакета, в котором была совершена операция.
- Объект - название объекта, над которым была совершена операция.
- Статус - результат операции: "Успешно" или возникшая ошибка.

## Фильтрация

С помощью фильтрации можно легко найти информацию об операции.

![image](https://storage.yandexcloud.net/zakroma-ru/media/768c5b715320bfefa12f42ee435d7609.png)

Доступные параметры фильтрации:

| Название фильтра                | Использование                                                                                                                                                                     |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Пользователь                    | Введите логин пользователя для поиска совершенных им операций.                                                                                                                    |
| Операция                        | Выберите операцию из списка для поиска всех совершенных соответствующих операций.                                                                                                 |
| Период начало, период окончание | Нажмите на поле и введите дату или нажмите на иконку календаря и выберите период начала и/или окончания операции для поиска операций, совершенных в определенную дату или период. |
| Рабочая область                 | Введите названия рабочей области для поиска всех операции, совершенных в соответствующей рабочей области.                                                                         |
| Bucket                          | Введите название bucket для поиска всех операций, совершенных в соответствующем bucket.                                                                                           |
| Объект                          | Введите название объекта для поиска всех операций, совершенных над соответствующим объектом.                                                                                      |

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

Операции

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

Доступ

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

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

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

Описание общей архитектуры решения и компонент

Архитектура решения

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

Требования

С чего начать

Установка Закрома.Хранение

Установка

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

Бакет (bucket)

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

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

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

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

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

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

CORS

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

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

Хранилища

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

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

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

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

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

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

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

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

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

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

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

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

Роли

Настройка конфигурации для пакетов

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

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

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

Настройка конфигурации для kubernetes

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

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

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

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

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

Webhooks

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

Расширение

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

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

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

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

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

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

Масштабирование объёма хранения

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

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

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

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

Отказоустойчивость

Краткое описание схемы работы Erasure Coding

Пример работы c S3 через S3 Browser

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

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

Работа с S3 Browser

Использование

Что изменилось в приложении в текущем релизе