Pular para o conteúdo principal
Versão: 0.4 · atual

Gerenciar entidades

Guia de instruçõesRevisado em 11 de outubro de 2026
Aplica-se a:Excubius 0.4Funções: Administrador de entidade
PlanosFree · Core · Pro · EnterpriseImplantaçãoAuto-hospedado

As entidades formam a árvore que contém os seus recursos: empresas, clientes, ambientes, equipes. O que você define em uma entidade é herdado por tudo o que está abaixo dela. Este guia mostra como criar e alterar a árvore em Settings › Entities, onde definir o que cada entidade transmite para baixo e como aplicar marcas aos recursos para agrupá-los em toda a árvore.

Antes de começar​

  • Você precisa da função Entity admin (Administrador de entidade) na entidade que vai alterar. Para criar uma entidade, você precisa dela na entidade pai; para mover uma, na entidade e no novo pai dela.
  • Planeje os níveis de que você precisa. Os tipos de entidade (locatário, cliente, ambiente, grupo) são rótulos e não alteram nenhum comportamento. Para entender como a herança funciona, consulte Entidades, marcas e herança.

Nos exemplos, Pelourinho Digital é a raiz, Veredas Ltda. é um cliente abaixo dela e Production e UAT são os ambientes desse cliente.

Criar uma entidade​

  1. Abra Settings › Entities. A árvore mostra a entidade escolhida no seletor e tudo o que está abaixo dela, com o número de recursos em cada ramo.
  2. Na entidade pai, por exemplo Veredas Ltda., abra o menu de ações e selecione Add an entity below.
  3. Digite o Name, por exemplo Production.
  4. Escolha o Kind, por exemplo environment.
  5. Se quiser, digite um Short name, usado nos caminhos: letras minúsculas, dígitos e hifens, único em toda a instalação. Quando você o deixa vazio, ele é derivado do nome. Ele não pode ser alterado depois.
  6. Selecione Create.

Existe apenas uma entidade raiz; todas as outras entidades têm um pai.

Renomear uma entidade​

  1. Abra o menu de ações da entidade e selecione Rename.
  2. Altere o Name e, se necessário, o Kind. O tipo da raiz não pode ser alterado.
  3. Selecione Save.

O nome curto permanece como estava, para que links e caminhos continuem funcionando.

Mover uma entidade​

Mover uma entidade move tudo o que está abaixo dela, e a partir daí tudo herda do novo lugar: limites, canais do Slack, janelas de manutenção, registro e funções.

  1. Abra o menu de ações da entidade e selecione Move.
  2. Escolha o New parent. Somente as entidades que você administra são oferecidas, e nunca a própria entidade nem uma abaixo dela.
  3. Selecione Move.

A raiz não pode ser movida. O log de auditoria registra cada movimentação.

Excluir uma entidade​

Você pode excluir uma entidade quando não restar nada abaixo dela.

  1. Remova ou mova o que ela contém: entidades filhas, recursos e fontes. Excluir um recurso também exclui os alertas dele.
  2. Abra o menu de ações da entidade e selecione Delete. A opção só fica disponível quando a entidade está vazia.
  3. Selecione Delete para confirmar. As credenciais, os canais do Slack e as atribuições de função da própria entidade são excluídos junto com ela.

O Excubius recusa a exclusão quando a entidade ainda tem entidades filhas, recursos, fontes ou alertas, ou quando recursos em outro lugar usam uma das credenciais dela. A raiz não pode ser excluída.

Definir o que uma entidade transmite para baixo​

Cada configuração herdada tem a própria tela. Escolha a entidade no seletor ou abra-a em Settings › Entities.

ConfiguraçãoOndeGuia
Padrões de limite de cada verificaçãoSettings › Entities, menu de ações, Threshold defaultsAlterar limites e desativar verificações
Funções e quem recebe uma contaSettings › Users and rolesGerenciar usuários e funções
Credenciais para o coletorSettings › CredentialsArmazenar uma credencial para o coletor
Canais do SlackSettings › NotificationsConfigurar notificações do Slack
Janelas de manutençãoSettings › Maintenance windowsPlanejar uma janela de manutenção
Tema e logotipo padrãoSettings › Branch appearanceConfigurar a página de status pública
Página de status públicaSettings › Status pageConfigurar a página de status pública

Aplicar marcas aos recursos​

As marcas são rótulos key:value nos recursos, como env:prod, role:sql ou client:ciguapa. Um recurso fica em um único lugar da árvore, mas as marcas permitem agrupá-lo com outros de qualquer parte da árvore.

Para aplicar marcas a um recurso:

  1. Abra o recurso e selecione Edit. Quando você adiciona um recurso, o assistente tem uma etapa Tags que funciona da mesma forma.
  2. Em Tags, digite pares key:value separados por espaços, por exemplo env:prod role:sql client:ciguapa. As chaves usam letras, dígitos, ponto, hífen e sublinhado, e cada chave aparece uma vez.
  3. Defina a Criticality, de 1 (baixa) a 5 (crítica). É um campo próprio, não uma marca, e é usado para roteamento, risco e a pontuação de segurança.
  4. Selecione Save.

Use pelo menos env, role e client em todos os recursos e defina a criticidade.

Para usar as marcas:

  • Em Resources, digite uma Tag rule. role:sql env:prod mostra os recursos que têm as duas; uma chave sozinha, como client, mostra todos os recursos que têm essa chave.
  • No painel Overview, escolha a exibição Hex e Group by uma chave de marca para ver um grupo de hexágonos por valor.

Fazer isso com a API​

TarefaSolicitação
CriarPOST /api/v1/entities com parent_id, name, kind e slug opcionais
Renomear ou alterar o tipoPATCH /api/v1/entities/{id} com name ou kind
MoverPATCH /api/v1/entities/{id} com parent_id
ExcluirDELETE /api/v1/entities/{id}; responde 409 com o motivo enquanto a entidade não está vazia
Aplicar marcas a um recursoPATCH /api/v1/resources/{id} com tags, um objeto como {"env": "prod", "role": "sql"}, e criticality