Recursos personalizados

Processo de criação e atualização

Cada vez que você altera o campo spec em qualquer um dos recursos personalizados suportados, o seguinte fluxo de trabalho é iniciado no Atlas Kubernetes Operator:

1. O Atlas Kubernetes Operator recebe um evento sobre o recurso personalizado alterado.

2. O Atlas Kubernetes Operator atualiza o campo status.conditions para refletir que o recurso não está pronto:

   conditions:
   - lastTransitionTime: "2021-03-13T16:26:17Z"
     status: "False"
     type: Ready

3. Para se conectar à API de Administração do Atlas, o Atlas Kubernetes Operator lê o ID da organização e as chaves deAPI do de um dos seguintes locais:

   • spec.connectionSecretRef.name (se especificado no Recurso PersonalizadoAtlasProject ).

     Por padrão, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o AtlasProject recurso personalizado. Para armazenar segredos em outro namespace, especifique o parâmetro spec.connectionSecretRef.namespace.

   • global Segredo do Atlas Kubernetes Operator secret <operator-deployment-name>-api-key (se spec.connectionSecretRef.name não for especificado).

4. Para criar ou atualizar recursos no Atlas, o Atlas Kubernetes Operator utiliza as informações de conexão para fazer chamadas de API para o Atlas.

   Observação

   Às vezes, o Atlas Kubernetes Operator faz múltiplas chamadas de API no Atlas durante a reconciliação de um recurso personalizado. Por exemplo, AtlasProject tem uma configuração de lista de acesso IP para chamar a API correspondente.

5. Se ocorrer algum erro durante a reconciliação, status.conditions será atualizado para refletir o erro.

   Exemplo

   - lastTransitionTime: "2021-03-15T14:26:44Z"
      message: 'POST https://cloud.mongodb.com/api/atlas/v1.0/groups/604a47de73cd8cag77239021/accessList:
         400 (request "INVALID_IP_ADDRESS_OR_CIDR_NOTATION") The address 192.0.2.1dfdfd5
         must be in valid IP address or CIDR notation.'
      reason: ProjectIPAccessListNotCreatedInAtlas
      status: "False"
      type: IPAccessListReady

6. Se a atualização for bem-sucedida, status.conditions reflete que o recurso está pronto:

   conditions:
   - lastTransitionTime: "2021-03-13T16:26:17Z"
     status: "True"
     type: Ready

Excluir processo

A partir do Atlas Kubernetes Operator 2.0, quando você exclui um recurso personalizado do Kubernetes, o objeto permanece no Atlas por padrão, mas o Atlas Kubernetes Operator não controla mais o objeto. Você pode reverter esse padrão para todo o seu sistema ou substituir esse padrão por um recurso personalizado específico por uma anotação para permitir que o Atlas Kubernetes Operator exclua o objeto correspondente do Atlas. Se você substituir por uma anotação, o seguinte fluxo de trabalho será iniciado:

1. O Atlas Kubernetes Operator recebe um evento sobre o recurso personalizado excluído.

2. Para se conectar à API de Administração do Atlas, o Atlas Kubernetes Operator lê o ID da organização e as chaves de API de um dos seguintes locais:

   • spec.connectionSecretRef.name (se especificado no Recurso PersonalizadoAtlasProject ).

     Por padrão, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o recurso personalizado AtlasProject . Para armazenar segredos em outro namespace, especifique o parâmetro spec.connectionSecretRef.namespace.

   • global Segredo do Atlas Kubernetes Operator secret <operator-deployment-name>-api-key (se spec.connectionSecretRef.name não for especificado).

3. Para excluir o recurso do Atlas, o Atlas Kubernetes Operator utiliza as informações de conexão para fazer chamadas de API para o Atlas.

   Observação

   O Atlas Kubernetes Operator remove quaisquer objetos relacionados criados no Kubernetes. Por exemplo, se você AtlasDatabaseUser remover o, o Atlas Kubernetes Operator removerá os segredos de conexão relacionados.

Usar anotações para ignorar ou substituir padrões

Você pode utilizar anotações para modificar o novo comportamento padrão do Atlas Kubernetes Operator.

• Se você adicionar a mongodb.com/atlas-resource-policy: "delete" anotação ao de um recurso metadata personalizado, o Atlas Kubernetes Operator excluirá o objeto correspondente no Atlas quando você excluir o recurso do Atlas Kubernetes Operator.

  Exemplo

  apiVersion: atlas.mongodb.com/v1
  kind: AtlasProject
  metadata:
    name: my-project
    annotations:
      mongodb.com/atlas-resource-policy: "delete"

• Se você tiver revertido o novo comportamento de exclusão para o padrão usado antes do Atlas Kubernetes Operator 2.0, você poderá adicionar a mongodb.com/atlas-resource-policy: "keep" anotação ao de um recurso personalizado metadata para que o Atlas Kubernetes Operator não exclua o recurso quando você excluir o Atlas Kubernetes Recurso do operador.

• Se você adicionar a mongodb.com/atlas-reconciliation-policy: "skip" anotação ao de um metadata recurso personalizado, o Atlas Kubernetes Operator não iniciará a reconciliação para o recurso. Essa anotação permite pausar a sincronização com a especificação até remover a anotação. Você pode usar essa anotação para fazer alterações manuais em um recurso personalizado e evitar que o Atlas Kubernetes Operator as desfaça durante uma sincronização. Quando você remove essa anotação, o Atlas Kubernetes Operator reconcilia o recurso e o sincroniza com a especificação.

• Se você adicionar a mongodb.com/atlas-resource-version-policy: "allow" anotação ao de um metadata recurso personalizado, o Atlas Kubernetes Operator permitirá que você use um recurso mesmo que o rótulo de versão não corresponda à versão do Atlas Kubernetes Operator que você está usando. Se a sua versão do recurso for uma versão principal atrás da versão do Atlas Kubernetes Operator, os recursos mais recentes podem não funcionar. As inconsistências de versão secundárias são compatíveis com versões anteriores.