Gérer les entités
Les entités forment l'arborescence qui contient vos ressources : entreprises, clients, environnements, équipes. Tout ce que vous définissez sur une entité est hérité par tout ce qui se trouve en dessous. Ce guide explique comment construire et modifier l'arborescence sous Settings › Entities, où définir ce que chaque entité transmet, et comment ajouter des étiquettes aux ressources pour les regrouper dans toute l'arborescence.
Avant de commencer
- Vous devez disposer du rôle Entity admin sur l'entité que vous modifiez. Pour créer une entité, il vous faut ce rôle sur le parent ; pour en déplacer une, sur l'entité et sur son nouveau parent.
- Planifiez les niveaux dont vous avez besoin. Les types d'entité (tenant, client, environment, group) sont de simples libellés et ne changent aucun comportement. Pour comprendre le fonctionnement de l'héritage, consultez Entités, étiquettes et héritage.
Dans les exemples, Montmartre Conseil est la racine, Combray SA est un client situé en dessous, et Production et UAT sont ses environnements.
Créer une entité
- Ouvrez Settings › Entities. L'arborescence affiche l'entité choisie dans le sélecteur et tout ce qui se trouve en dessous, avec le nombre de ressources de chaque branche.
- Sur le parent, par exemple Combray SA, ouvrez son menu d'actions et sélectionnez Add an entity below.
- Saisissez le Name, par exemple
Production. - Choisissez le Kind, par exemple environment.
- Si vous le souhaitez, saisissez un Short name, utilisé dans les chemins : lettres minuscules, chiffres et traits d'union, unique dans toute l'installation. Si vous le laissez vide, il est dérivé du nom. Il ne peut pas être modifié par la suite.
- Sélectionnez Create.
Il n'existe qu'une seule entité racine ; toutes les autres entités ont un parent.
Renommer une entité
- Ouvrez le menu d'actions de l'entité et sélectionnez Rename.
- Modifiez le Name, et le Kind si nécessaire. Le type de la racine ne peut pas changer.
- Sélectionnez Save.
Le nom court reste inchangé ; les liens et les chemins continuent donc de fonctionner.
Déplacer une entité
Déplacer une entité déplace tout ce qui se trouve en dessous, et à partir de ce moment, l'ensemble hérite de son nouvel emplacement : seuils, canaux Slack, fenêtres de maintenance, inscription et rôles.
- Ouvrez le menu d'actions de l'entité et sélectionnez Move.
- Choisissez le New parent. Seules les entités que vous administrez sont proposées, et jamais l'entité elle-même ni une entité située en dessous.
- Sélectionnez Move.
La racine ne peut pas être déplacée. Le journal d'audit enregistre chaque déplacement.
Supprimer une entité
Vous pouvez supprimer une entité dès qu'il ne reste plus rien en dessous.
- Supprimez ou déplacez ce qu'elle contient : entités enfants, ressources et sources. La suppression d'une ressource supprime aussi ses alertes.
- Ouvrez le menu d'actions de l'entité et sélectionnez Delete. L'option n'est disponible que lorsque l'entité est vide.
- Sélectionnez Delete pour confirmer. Les informations d'identification, les canaux Slack et les attributions de rôles propres à l'entité sont supprimés avec elle.
Excubius refuse la suppression lorsque l'entité possède encore des entités enfants, des ressources, des sources ou des alertes, ou lorsque des ressources situées ailleurs utilisent l'une de ses informations d'identification. La racine ne peut pas être supprimée.
Définir ce qu'une entité transmet
Chaque paramètre hérité a son propre écran. Choisissez l'entité dans le sélecteur ou ouvrez-la depuis Settings › Entities.
| Paramètre | Emplacement | Guide |
|---|---|---|
| Seuils par défaut de chaque vérification | Settings › Entities, menu d'actions, Threshold defaults | Modifier les seuils et désactiver des vérifications |
| Rôles et personnes qui obtiennent un compte | Settings › Users and roles | Gérer les utilisateurs et les rôles |
| Informations d'identification du collecteur | Settings › Credentials | Stocker des informations d'identification pour le collecteur |
| Canaux Slack | Settings › Notifications | Configurer les notifications Slack |
| Fenêtres de maintenance | Settings › Maintenance windows | Planifier une fenêtre de maintenance |
| Thème et logo par défaut | Settings › Branch appearance | Configurer la page d'état publique |
| Page d'état publique | Settings › Status page | Configurer la page d'état publique |
Ajouter des étiquettes aux ressources
Les étiquettes sont des libellés key:value appliqués aux ressources, comme env:prod, role:sql ou client:ciguapa. Une ressource occupe un seul emplacement dans l'arborescence, mais les étiquettes vous permettent de la regrouper avec d'autres ressources de n'importe quel endroit de l'arborescence.
Pour ajouter des étiquettes à une ressource :
- Ouvrez la ressource et sélectionnez Edit. Lorsque vous ajoutez une ressource, l'Assistant comporte une étape Tags qui fonctionne de la même façon.
- Dans Tags, saisissez des paires
key:valueséparées par des espaces, par exempleenv:prod role:sql client:ciguapa. Les clés utilisent des lettres, des chiffres, le point, le tiret et le trait de soulignement, et chaque clé n'apparaît qu'une fois. - Définissez la Criticality, de 1 (faible) à 5 (critique). Il s'agit d'un champ distinct, pas d'une étiquette, qui sert au routage, au risque et au score de sécurité.
- Sélectionnez Save.
Utilisez au moins env, role et client sur chaque ressource, et définissez la criticité.
Pour utiliser les étiquettes :
- Dans Resources, saisissez une Tag rule.
role:sql env:prodaffiche les ressources qui ont les deux ; une clé seule, commeclient, affiche toutes les ressources qui ont cette clé. - Sur le tableau de bord Overview, choisissez la vue Hex et utilisez Group by avec une clé d'étiquette pour afficher un groupe d'hexagones par valeur.
Utiliser l'API
| Tâche | Requête |
|---|---|
| Créer | POST /api/v1/entities avec parent_id, name, et facultativement kind et slug |
| Renommer ou changer le type | PATCH /api/v1/entities/{id} avec name ou kind |
| Déplacer | PATCH /api/v1/entities/{id} avec parent_id |
| Supprimer | DELETE /api/v1/entities/{id} ; répond 409 avec le motif tant que l'entité n'est pas vide |
| Ajouter des étiquettes à une ressource | PATCH /api/v1/resources/{id} avec tags, un objet tel que {"env": "prod", "role": "sql"}, et criticality |