Перейти к основному содержимому
Версия: 0.4 · текущая

Управление сущностями

Практическое руководствоПроверено 11 октября 2026 г.
Область применения:Excubius 0.4Роли: Администратор сущности
ПланыFree · Core · Pro · EnterpriseРазвертываниеСамостоятельное размещение

Сущности образуют дерево, в котором находятся ваши ресурсы: компании, клиенты, среды, команды. Все, что вы задаете для сущности, наследуется всеми элементами ниже нее. В этом руководстве показано, как создавать и изменять дерево в разделе Settings › Entities, где задавать параметры, которые каждая сущность передает вниз, и как назначать ресурсам теги, чтобы группировать их по всему дереву.

Перед началом работы​

  • Вам нужна роль Entity admin (администратор сущности) для изменяемой сущности. Чтобы создать сущность, роль нужна для родительской сущности; чтобы переместить сущность — для нее самой и для ее нового родителя.
  • Спланируйте нужные уровни. Виды сущностей (клиент-арендатор, клиент, среда, группа) являются метками и не меняют поведения. Принцип наследования описан в статье Сущности, теги и наследование.

В примерах корнем является АО «Ясная Поляна», ООО «Лукоморье» — клиент под ним, а Production и UAT — его среды.

Создание сущности​

  1. Откройте Settings › Entities. В дереве отображается сущность, выбранная в средстве выбора, и все, что находится ниже нее, с количеством ресурсов в каждой ветви.
  2. У родительской сущности, например ООО «Лукоморье», откройте меню действий и выберите Add an entity below.
  3. Введите Name, например Production.
  4. Выберите Kind, например environment.
  5. При необходимости введите Short name, который используется в путях: строчные буквы, цифры и дефисы, уникальное в пределах установки. Если оставить поле пустым, короткое имя формируется из имени. Изменить его позже нельзя.
  6. Выберите Create.

Корневая сущность только одна; у каждой другой сущности есть родитель.

Переименование сущности​

  1. Откройте меню действий сущности и выберите Rename.
  2. Измените Name и при необходимости Kind. Вид корневой сущности изменить нельзя.
  3. Выберите Save.

Короткое имя остается прежним, поэтому ссылки и пути продолжают работать.

Перемещение сущности​

При перемещении сущности перемещается все, что находится ниже нее, и с этого момента все это наследует параметры от нового места: пороговые значения, каналы Slack, окна обслуживания, регистрацию и роли.

  1. Откройте меню действий сущности и выберите Move.
  2. Выберите New parent. Предлагаются только сущности, которые вы администрируете, и никогда сама сущность или сущности ниже нее.
  3. Выберите Move.

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

Удаление сущности​

Сущность можно удалить, когда под ней ничего не осталось.

  1. Удалите или переместите ее содержимое: дочерние сущности, ресурсы и источники. При удалении ресурса удаляются и его оповещения.
  2. Откройте меню действий сущности и выберите Delete. Этот вариант доступен, только если сущность пуста.
  3. Выберите Delete для подтверждения. Собственные учетные данные сущности, каналы Slack и назначения ролей удаляются вместе с ней.

Excubius отказывает в удалении, если у сущности еще есть дочерние сущности, ресурсы, источники или оповещения либо если ресурсы в другом месте используют одни из ее учетных данных. Корневую сущность удалить нельзя.

Параметры, которые сущность передает вниз​

У каждого наследуемого параметра есть собственный экран. Выберите сущность в средстве выбора или откройте ее в разделе Settings › Entities.

ПараметрГдеРуководство
Пороговые значения по умолчанию для каждой проверкиSettings › Entities, меню действий, Threshold defaultsИзменение пороговых значений и отключение проверок
Роли и кто получает учетную записьSettings › Users and rolesУправление пользователями и ролями
Учетные данные для сборщикаSettings › CredentialsСохранение учетных данных для сборщика
Каналы SlackSettings › NotificationsНастройка уведомлений Slack
Окна обслуживанияSettings › Maintenance windowsПланирование окна обслуживания
Тема и логотип по умолчаниюSettings › Branch appearanceНастройка общедоступной страницы состояния
Общедоступная страница состоянияSettings › Status pageНастройка общедоступной страницы состояния

Назначение тегов ресурсам​

Теги — это метки key:value на ресурсах, например env:prod, role:sql или client:ciguapa. Ресурс находится в одном месте дерева, но теги позволяют группировать его с другими ресурсами из любой части дерева.

Чтобы назначить теги ресурсу, выполните следующие действия.

  1. Откройте ресурс и выберите Edit. При добавлении ресурса в мастере есть шаг Tags, который работает так же.
  2. В поле Tags введите пары key:value через пробел, например env:prod role:sql client:ciguapa. Ключи состоят из букв, цифр, точки, дефиса и подчеркивания, и каждый ключ указывается один раз.
  3. Задайте Criticality от 1 (низкая) до 5 (критическая). Это отдельное поле, а не тег; оно используется для маршрутизации, оценки риска и расчета оценки безопасности.
  4. Выберите 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