Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Configurar Acesso ao Atlas

Para se conectar à API de administração do Atlas , o Atlas Kubernetes Operator lê o ID da organização e as chaves API dos segredos do Atlas Kubernetes Operator . Você também pode configurar as seguintes funcionalidades:

Para aprender mais sobre como criar uma conta do Atlas, consulte Registrar e conectar no Atlas.

Dependendo da configuração, o Atlas Kubernetes Operator faz a leitura de um dos seguintes Atlas Kubernetes Operator secrets:

Escopo
Localização
Descrição

Global

Segredo do Atlas Kubernetes Operator <operator-deployment-name>-api-key criado no mesmo namespace onde foi instalado o Atlas Kubernetes Operator.

O Atlas Kubernetes Operator utiliza estes dados secretos para se conectar à Administration API do Atlas, a não ser que o AtlasProject recurso personalizado especifique spec.connectionSecretRef.name.

global O Atlas Kubernetes Operator secrets permite que você use uma chave de API para todos os projetos em uma organização. Qualquer novo AtlasProject Recurso personalizado usa a mesma chave de API para reduzir a sobrecarga.

O nome padrão do sistema Atlas Kubernetes Operator é mongodb-atlas-operator. Então, o segredo deve ser nomeado mongodb-atlas-operator-api-key.

Projeto

Segredo do Atlas Kubernetes Operator referenciado como spec.connectionSecretRef.name AtlasProject no recurso Personalizado.

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 spec.connectionSecretRef. parâmetro do namespace .

O Atlas Kubernetes Operator usa esses dados secretos para se conectar à API de administração do Atlas para qualquer AtlasDeployment recurso personalizado e AtlasDatabaseUser recurso personalizado que faça referência ao projeto.

Se você não especificar spec.connectionSecretRef.name, o Atlas Kubernetes Operator global Atlas Kubernetes Operator o segredo.

Os segredos do Atlas Kubernetes Operator por projeto permitem um acesso mais granular. Talvez você queira que uma única chave de API tenha acesso a um único projeto do Atlas.

Tanto os segredos global quanto project exigem as seguintes informações:

Parâmetro
Descrição

orgId

string hexadecimal exclusiva de 24dígitos usada para identificar a organização Atlas .

publicAPIKey

Parte pública da chave API.

privateAPIKey

Parte privada da chave API.

Você precisa das seguintes informações da chave de API pública, chave de API privada e ID da organização para configurar o acesso do Atlas Kubernetes Operator ao Atlas.

  • Se você quiser que o Atlas Kubernetes Operator crie um novo projeto do Atlas , concedaacesso programático a uma organização. Se sua organização exigir uma lista de acesso IP para a API Atlas Administration, você também deverá configurar a lista de acesso da API.

    Importante

    Você deve atribuir a chave API ao role da organização Organization Project Creator ou superior.

  • Se você quiser trabalhar com um projeto Atlas existente, adicione acesso a um projeto. Se sua organização exigir uma lista de acesso IP para a API Atlas Administration, você também deverá configurar a lista de acesso da API.

    Importante

    Você deve atribuir à chave de API ao role de projeto Project Owner .

Para configurar o acesso do Atlas Kubernetes Operator ao Atlas, execute uma das etapas a seguir.

  • Para obter um segredo global do Atlas Kubernetes Operator segredo, execute os seguintes comandos:

    Observação

    O nome do segredo do Atlas Kubernetes Operator global deve estar em conformidade com o formato predefinido. O nome padrão do sistema Atlas Kubernetes Operator é mongodb-atlas-operator. Então, o segredo deve ser nomeado como mongodb-atlas-operator-api-key.

    kubectl create secret generic mongodb-atlas-operator-api-key \ --from-literal="orgId=<the_atlas_organization_id>" \ --from-literal="publicApiKey=<the_atlas_api_public_key>" \ --from-literal="privateApiKey=<the_atlas_api_private_key>" \ -n <operator_namespace> kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system
  • Para obter um segredo project do Atlas Kubernetes Operator segredo, execute os seguintes comandos:

    kubectl create secret generic my-project-connection \ --from-literal="orgId=<the_atlas_organization_id>" \ --from-literal="publicApiKey=<the_atlas_api_public_key>" \ --from-literal="privateApiKey=<the_atlas_api_private_key>" \ -n <atlas_project_namespace> kubectl label secret mongodb-atlas-operator-api-key atlas.mongodb.com/type=credentials -n mongodb-atlas-system