Administrar entidades
Las entidades forman el árbol que contiene tus recursos: empresas, clientes, entornos, equipos. Lo que configuras en una entidad lo hereda todo lo que está debajo de ella. Esta guía muestra cómo construir y cambiar el árbol en Configuración › Entidades, dónde configurar lo que cada entidad transmite hacia abajo y cómo etiquetar recursos para agruparlos en todo el árbol.
Antes de empezar
- Necesitas el rol Administrador de entidad en la entidad que cambias. Para crear una entidad, lo necesitas en la entidad padre; para mover una, en la entidad y en su nuevo padre.
- Planifica los niveles que necesitas. Los tipos de entidad (inquilino, cliente, entorno, grupo) son etiquetas descriptivas y no cambian ningún comportamiento. Para saber cómo funciona la herencia, consulta Entidades, etiquetas y herencia.
En los ejemplos, Areito Corporation es la raíz, Ciguapa Inc. es un cliente debajo de ella, y Producción y UAT son sus entornos.
Crear una entidad
- Abre Configuración › Entidades. El árbol muestra la entidad elegida en el selector y todo lo que está debajo, con el número de recursos de cada rama.
- En la entidad padre, por ejemplo Ciguapa Inc., abre su menú de acciones y selecciona Agregar una entidad debajo.
- Escribe el Nombre, por ejemplo
Production. - Elige el Tipo, por ejemplo entorno.
- Si quieres, escribe un Nombre corto, que se usa en las rutas: letras minúsculas, dígitos y guiones, único en toda la instalación. Si lo dejas vacío, se deriva del nombre. No se puede cambiar después.
- Selecciona Crear.
Solo hay una entidad raíz; todas las demás entidades tienen un padre.
Cambiar el nombre de una entidad
- Abre el menú de acciones de la entidad y selecciona Cambiar el nombre.
- Cambia el Nombre y, si hace falta, el Tipo. El tipo de la raíz no puede cambiar.
- Selecciona Guardar.
El nombre corto no cambia, así que los enlaces y las rutas siguen funcionando.
Mover una entidad
Mover una entidad mueve todo lo que está debajo de ella, y a partir de ese momento todo hereda de su nuevo lugar: umbrales, canales de Slack, ventanas de mantenimiento, registro y roles.
- Abre el menú de acciones de la entidad y selecciona Mover.
- Elige el Nuevo padre. Solo se ofrecen entidades que administras, y nunca la propia entidad ni una que esté debajo de ella.
- Selecciona Mover.
La raíz no se puede mover. El registro de auditoría guarda cada movimiento.
Eliminar una entidad
Puedes eliminar una entidad cuando ya no queda nada debajo de ella.
- Quita o mueve lo que contiene: entidades hijas, recursos y fuentes. Eliminar un recurso también elimina sus alertas.
- Abre el menú de acciones de la entidad y selecciona Eliminar. La opción solo está disponible cuando la entidad está vacía.
- Selecciona Eliminar para confirmar. Las credenciales, los canales de Slack y las asignaciones de roles propios de la entidad se eliminan con ella.
Excubius rechaza la eliminación cuando la entidad todavía tiene entidades hijas, recursos, fuentes o alertas, o cuando recursos de otras partes usan una de sus credenciales. La raíz no se puede eliminar.
Configurar lo que una entidad transmite
Cada configuración heredada tiene su propia pantalla. Elige la entidad en el selector, o ábrela desde Configuración › Entidades.
| Configuración | Dónde | Guía |
|---|---|---|
| Umbrales predeterminados de cada comprobación | Configuración › Entidades, menú de acciones, Umbrales predeterminados | Cambiar umbrales y desactivar comprobaciones |
| Roles y quién obtiene una cuenta | Configuración › Usuarios y roles | Administrar usuarios y roles |
| Credenciales para el recolector | Configuración › Credenciales | Guardar una credencial para el recolector |
| Canales de Slack | Configuración › Notificaciones | Configurar las notificaciones de Slack |
| Ventanas de mantenimiento | Configuración › Ventanas de mantenimiento | Planificar una ventana de mantenimiento |
| Tema y logotipo predeterminados | Configuración › Apariencia de la rama | Configurar la página de estado pública |
| Página de estado pública | Configuración › Página de estado | Configurar la página de estado pública |
Etiquetar recursos
Las etiquetas son pares key:value en los recursos, como env:prod, role:sql o client:ciguapa. Un recurso vive en un solo lugar del árbol, pero las etiquetas te permiten agruparlo con otros desde cualquier parte del árbol.
Para etiquetar un recurso:
- Abre el recurso y selecciona Editar. Cuando agregas un recurso, el asistente tiene un paso Etiquetas que funciona igual.
- En Etiquetas, escribe pares
key:valueseparados por espacios, por ejemploenv:prod role:sql client:ciguapa. Las claves usan letras, dígitos, punto, guion y guion bajo, y cada clave aparece una sola vez. - Establece la Criticidad, de 1 (baja) a 5 (crítica). Es un campo propio, no una etiqueta, y se usa para el enrutamiento, el riesgo y la puntuación de seguridad.
- Selecciona Guardar.
Usa al menos env, role y client en cada recurso, y establece la criticidad.
Para usar las etiquetas:
- En Recursos, escribe una Regla de etiquetas.
role:sql env:prodmuestra los recursos que tienen ambas; una clave sola, comoclient, muestra todos los recursos que tienen esa clave. - En la Vista general, elige la vista Hexágonos y Agrupar por una clave de etiqueta para ver un grupo de hexágonos por valor.
Hacerlo con la API
| Tarea | Solicitud |
|---|---|
| Crear | POST /api/v1/entities con parent_id, name y, opcionalmente, kind y slug |
| Cambiar el nombre o el tipo | PATCH /api/v1/entities/{id} con name o kind |
| Mover | PATCH /api/v1/entities/{id} con parent_id |
| Eliminar | DELETE /api/v1/entities/{id}; responde 409 con el motivo mientras la entidad no esté vacía |
| Etiquetar un recurso | PATCH /api/v1/resources/{id} con tags, un objeto como {"env": "prod", "role": "sql"}, y criticality |