Управление сущностями
Сущности образуют дерево, в котором находятся ваши ресурсы: компании, клиенты, среды, команды. Все, что вы задаете для сущности, наследуется всеми элементами ниже нее. В этом руководстве показано, как создавать и изменять дерево в разделе Settings › Entities, где задавать параметры, которые каждая сущность передает вниз, и как назначать ресурсам теги, чтобы группировать их по всему дереву.
Перед началом работы
- Вам нужна роль Entity admin (администратор сущности) для изменяемой сущности. Чтобы создать сущность, роль нужна для родительской сущности; чтобы переместить сущность — для нее самой и для ее нового родителя.
- Спланируйте нужные уровни. Виды сущностей (клиент-арендатор, клиент, среда, группа) являются метками и не меняют поведения. Принцип наследования описан в статье Сущности, теги и наследование.
В примерах корнем является АО «Ясная Поляна», ООО «Лукоморье» — клиент под ним, а Production и UAT — его среды.
Создание сущности
- Откройте Settings › Entities. В дереве отображается сущность, выбранная в средстве выбора, и все, что находится ниже нее, с количеством ресурсов в каждой ветви.
- У родительской сущности, например ООО «Лукоморье», откройте меню действий и выберите Add an entity below.
- Введите Name, например
Production. - Выберите Kind, например environment.
- При необходимости введите Short name, который используется в путях: строчные буквы, цифры и дефисы, уникальное в пределах установки. Если оставить поле пустым, короткое имя формируется из имени. Изменить его позже нельзя.
- Выберите Create.
Корневая сущность только одна; у каждой другой сущности есть родитель.
Переименование сущности
- Откройте меню действий сущности и выберите Rename.
- Измените Name и при необходимости Kind. Вид корневой сущности изменить нельзя.
- Выберите Save.
Короткое имя остается прежним, поэтому ссылки и пути продолжают работать.
Перемещение сущности
При перемещении сущности перемещается все, что находится ниже нее, и с этого момента все это наследует параметры от нового места: пороговые значения, каналы Slack, окна обслуживания, регистрацию и роли.
- Откройте меню действий сущности и выберите Move.
- Выберите New parent. Предлагаются только сущности, которые вы администрируете, и никогда сама сущность или сущности ниже нее.
- Выберите Move.
Корневую сущность переместить нельзя. Каждое перемещение записывается в журнал аудита.
Удаление сущности
Сущность можно удалить, когда под ней ничего не осталось.
- Удалите или переместите ее содержимое: дочерние сущности, ресурсы и источники. При удалении ресурса удаляются и его оповещения.
- Откройте меню действий сущности и выберите Delete. Этот вариант доступен, только если сущность пуста.
- Выберите Delete для подтверждения. Собственные учетные данные сущности, каналы Slack и назначения ролей удаляются вместе с ней.
Excubius отказывает в удалении, если у сущности еще есть дочерние сущности, ресурсы, источники или оповещения либо если ресурсы в другом месте используют одни из ее учетных данных. Корневую сущность удалить нельзя.
Параметры, которые сущность передает вниз
У каждого наследуемого параметра есть собственный экран. Выберите сущность в средстве выбора или откройте ее в разделе Settings › Entities.
| Параметр | Где | Руководство |
|---|---|---|
| Пороговые значения по умолчанию для каждой проверки | Settings › Entities, меню действий, Threshold defaults | Изменение пороговых значений и отключение проверок |
| Роли и кто получает учетную запись | Settings › Users and roles | Управление пользователями и ролями |
| Учетные данные для сборщика | Settings › Credentials | Сохранение учетных данных для сборщика |
| Каналы Slack | Settings › Notifications | Настройка уведомлений Slack |
| Окна обслуживания | Settings › Maintenance windows | Планирование окна обслуживания |
| Тема и логотип по умолчанию | Settings › Branch appearance | Настройка общедоступной страницы состояния |
| Общедоступная страница состояния | Settings › Status page | Настройка общедоступной страницы состояния |
Назначение тегов ресурсам
Теги — это метки key:value на ресурсах, например env:prod, role:sql или client:ciguapa. Ресурс находится в одном месте дерева, но теги позволяют группировать его с другими ресурсами из любой части дерева.
Чтобы назначить теги ресурсу, выполните следующие действия.
- Откройте ресурс и выберите Edit. При добавлении ресурса в мастере есть шаг Tags, который работает так же.
- В поле Tags введите пары
key:valueчерез пробел, напримерenv:prod role:sql client:ciguapa. Ключи состоят из букв, цифр, точки, дефиса и подчеркивания, и каждый ключ указывается один раз. - Задайте Criticality от 1 (низкая) до 5 (критическая). Это отдельное поле, а не тег; оно используется для маршрутизации, оценки риска и расчета оценки безопасности.
- Выберите Save.
Используйте как минимум env, role и client для каждого ресурса и задайте критичность.
Как использовать теги:
- В разделе Resources введите Tag rule.
role:sql env:prodпоказывает ресурсы, у которых есть оба тега; ключ без значения, напримерclient, показывает все ресурсы с этим ключом. - На панели мониторинга Overview выберите представление Hex и в поле Group by укажите ключ тега, чтобы увидеть отдельную группу шестиугольников для каждого значения.
Выполнение через API
| Задача | Запрос |
|---|---|
| Создание | POST /api/v1/entities с parent_id, name, необязательными kind и slug |
| Переименование или смена вида | PATCH /api/v1/entities/{id} с name или kind |
| Перемещение | PATCH /api/v1/entities/{id} с parent_id |
| Удаление | DELETE /api/v1/entities/{id}; возвращает 409 с причиной, пока сущность не пуста |
| Назначение тегов ресурсу | PATCH /api/v1/resources/{id} с tags — объектом, например {"env": "prod", "role": "sql"}, — и criticality |