/ /

Recursos personalizados

Página inicial do Docs

Gestão

Atlas Kubernetes Operator

Recursos personalizados

Página inicial do Docs

Gestão

Atlas Kubernetes Operator

Recursos personalizados

`AtlasDeployment` Recurso personalizado

Migração para clusters flexíveis

Importante

Migração para clusters flexíveis

O Atlas desativou os clusters M2 e M5 e as instâncias sem servidor. O Atlas migrará automaticamente todos os clusters M2 e M5 para clusters Flex. Para instâncias sem servidor, o Atlas determinará se você deve migrar as instâncias para cluster livre, cluster flexível ou cluster dedicado de acordo com seu uso e, em seguida, migrar as instâncias sem servidor automaticamente. Para ver para quais níveis o Atlas migrará suas instâncias, consulte a página Todos os clusters na UI do Atlas. Para saber mais, consulte o Guia de migração flexível na documentação do Atlas.
Substitua referências a spec.serverlessSpec pela configuração para spec.flexSpec.
O Atlas Kubernetes Operator rejeita novos AtlasDeployment recursos personalizados que definem spec.serverlessSpec. Você só pode usar spec.serverlessSpec para gerenciar instâncias sem servidor existentes.

Alterações significativas com o Atlas Kubernetes Operator 2.0

Importante

ação necessária para alteração interruptiva com o Atlas Kubernetes Operator 2.0

Com o Atlas Kubernetes Operator 2.0, deploymentSpec substitui advancedDeploymentSpec no AtlasDeployment recurso personalizado. Você deve atualizar seu recurso personalizado do AtlasDeployment como segue:
- Se você usar advancedDeploymentSpec, renomeie-o para deploymentSpec. Você não precisa alterar nenhuma formatação.
- Se você usava deploymentSpec antes do Atlas Kubernetes Operator 2.0, reescreva seu AtlasDeployment recurso personalizado para corresponder à formatação usada nos exemplos.
O Atlas Kubernetes Operator usa arquivos de configuração derecurso personalizado para gerenciar sua configuração do Atlas . A partir do Atlas Kubernetes Operator 2.0, os recursos personalizados que você exclui no Kubernetes não são mais excluídos no Atlas. Em vez disso, o Atlas Kubernetes Operator simplesmente para de gerenciar estes recursos. Por exemplo, se você excluir um AtlasProject Recurso Personalizado em Kubernetes, o Atlas Kubernetes Operator não excluirá mais automaticamente o projeto correspondente do Atlas, evitando exclusões acidentais ou inesperadas. Para saber mais, incluindo como reverter este comportamento para o padrão utilizado antes do Atlas Kubernetes Operator 2.0, consulte Novo padrão: proteção de exclusão no Atlas Kubernetes Operator 2.0.

Sobre o Recurso Personalizado AtlasDeployment

O recurso personalizado do AtlasDeployment configura seu cluster MongoDB ou cluster Flex no Atlas. Quando você cria o recurso personalizado AtlasDeployment, o Atlas Kubernetes Operator tenta criar ou atualizar um cluster ou um cluster flexível no Atlas.

O Atlas Kubernetes Operator realiza uma das seguintes ação, dependendo dos valores que você especificar no recurso personalizado AtlasDeployment :

Se você especificar valores para campos em spec.deploymentSpec, O Atlas Kubernetes Operator usa o recurso API do Atlas Clusters para criar um novo cluster ou atualizar um cluster existente.
Se você especificar valores para campos em spec.flexSpec, O Atlas Kubernetes Operator usa o recurso Atlas Flex instância API para criar um novo cluster Flex ou atualizar um cluster existente.

Observação

Não especifique valores para campos em spec.serverlessSpec porque As instâncias sem servidor estão obsoletas. Em vez disso, especifique campos em spec.flexSpec. Para saber mais, consulte Migração para clusters Flex.

A criação de um cluster Atlas de camada grátis leva menos de 15 segundos.

A criação ou atualização de um cluster Flex ou cluster dedicado pode levar até 10 minutos. O Atlas Kubernetes Operator monitora o processo de atualização.

Você pode executar o seguinte comando para verificar o status:

kubectl get atlasdeployment -o yaml

O exemplo a seguir mostra a seção de status de um cluster que está provisionando:

status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "False"
    type: ClusterReady
    reason: ClusterCreating
    message: Cluster is provisioning

O status ClusterReady mudará para True quando o cluster ou a instância sem servidor estiver pronto.

Exemplos

Exemplo de status

O exemplo a seguir mostra o recurso AtlasDeployment com um status ClusterReady de True:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: US-Zone
        numShards: 3
        regionConfigs:
          - regionName: CENTRAL_US
            providerName: GCP
            backingProviderName: GCP
            priority: 7
            electableSpecs:
              instanceSize: M10
              nodeCount: 3
status:
  conditions:
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: Ready
  - lastTransitionTime: "2024-03-18T16:32:43Z"
    status: "True"
    type: ClusterReady
  connectionStrings:
    standard: mongodb://test-cluster-shard-00-00.kpc8f.mongodb.net:27017,test-cluster-shard-00-01.kpc8f.mongodb.net:27017,test-cluster-shard-00-02.kpc8f.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-1gm1pv-shard-0
    standardSrv: mongodb+srv://test-cluster.kpc8f.mongodb.net
  mongoDBVersion: 6.0
  mongoURIUpdated: "2024-03-12T12:21:41Z"
  observedGeneration: 1
  stateName: IDLE

Exemplo de configuração

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasDeployment configurada para clusters de várias regiões com auto-scaling:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  deploymentSpec:
    clusterType: REPLICASET
    name: service-name
    tags:
    - key: "environment"
      value: "production"
    backupEnabled: true
    replicationSpecs:
      - numShards: 1
        regionConfigs:
         - regionName: EASTERN_US
           providerName: GCP
           autoScaling:
             diskGB:
               enabled: true
             compute:
               enabled: true
               scaleDownEnabled: true
               minInstanceSize: M30
               maxInstanceSize: M40
           analyticsSpecs:
             instanceSize: M30
             nodeCount: 1
           electableSpecs:
             instanceSize: M30
             nodeCount: 3
           priority: 7
           readOnlySpecs:
             instanceSize: M30
             nodeCount: 1

Exemplo de opções adicionais

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasDeployment configurada com algumas das opções adicionais.

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    name: test-cluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
         - electableSpecs:
             instanceSize: M10
             nodeCount: 3
           providerName: AWS
           regionName: US_EAST_1
           priority: 7
  processArgs:
    javascriptEnabled: false

Exemplo de cluster flexível

Notas sobre transição para clusters flexíveis

Até 2026 de janeiro, para preservar a compatibilidade com versões anteriores por um período de tempo, o Atlas permite a você gerenciar clusters migrados por meio das APIs de instâncias sem servidor e de clusters flexíveis, inclusive quando você está usando o Atlas Kubernetes Operator.
Você pode criar e gerenciar clusters Flex no mesmo AtlasDeployment no qual você criou e gerenciou instâncias sem servidor e clusters M2 e M5.
Você não pode criar novos clusters M2/M5 e instâncias sem servidor no Atlas. Tentar fazer isso cria um cluster Flex .
Você ainda pode utilizar instâncias sem servidor existentes no Atlas Kubernetes Operator mesmo que as instâncias sem servidor existentes sejam preteridas a partir do início de fevereiro de 2025.
Para suas instâncias sem servidor existentes, você pode optar por substituir as referências a spec.serverlessSpec no AtlasDeployment pela configuração para spec.flexSpec. Ou você pode continuar usando a mesma especificação. O gerenciamento de uma implantação por meio do spec.serverlessSpec no AtlasDeployment recurso personalizado continuará funcionando mesmo depois que o Atlas migrar automaticamente esses clusters existentes para clusters flexíveis em março de 2025.
Para seus clusters M2 e M5 existentes, você pode optar por substituir as referências a spec.deploymentSpec no AtlasDeployment Recurso personalizado pela configuração de spec.flexSpec. Ou você pode continuar usando a mesma especificação. O gerenciamento de uma implantação por meio do spec.deploymentSpec no AtlasDeployment recurso personalizado continuará funcionando mesmo depois que o Atlas migrar automaticamente esses clusters M2 e M5 existentes para clusters Flex em maio de 2025.
Para suas instâncias sem servidor existentes, se você receber erros durante as reconciliações relacionadas a endpoints privados, deverá atualizar para o Atlas Kubernetes Operator 2.7.1 ou substituir a configuração serverlessSpec pela configuração de flexSpec no recurso personalizado AtlasDeployment.
Para seus clusters do M2 e M5, para evitar erros de reconciliação que você pode notar após a migração automática, faça as seguintes alterações em suas configurações de CRD:
- Remova a configuração spec.deploymentSpec.replicationSpecs.zoneName.
- Remova qualquer um dos spec.deploymentSpec.replicationSpecs.regionConfigs configurações após o primeiro conjunto de configurações.
- Especifique replicaset somente no spec.deploymentSpec.clusterType.
Alternativamente, substitua as referências ao spec.deploymentSpec no AtlasDeployment pela configuração para spec.flexSpec.
Até 2026 de janeiro, você deve remover todas as configurações restantes de M2/M5 e Instância sem servidor dos recursos personalizados do Atlas Kubernetes Operator, pois a compatibilidade com versões anteriores das APIs termina em 2026 de janeiro, quando as APIs antigas serão removidas e somente as APIs relacionados aos clusters Flex permanecerão em vigor.
As versões mais recentes do Atlas Kubernetes Operator deixarão de oferecer suporte aos clusters M2/M5 existentes e às instâncias sem servidor. As versões mais antigas do Atlas Kubernetes Operator continuarão a oferecer suporte a esses tipos de instância até janeiro de 2026.

Para saber mais, consulte Migration to Flex Clusters neste guia e o Guia de Migração Flex na documentação do Atlas .

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasDeployment configurada para um cluster Flex:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: my-project
  flexSpec:
    name: flex-cluster
    tags:
      - key: "environment"
        value: "production"
    providerSettings:
      backingProviderName: AWS
      regionName: US_EAST_1

Exemplo de instância sem servidor

Observação

O exemplo a seguir mostra uma especificação de recurso personalizado AtlasDeployment configurada para uma instância sem servidor:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: test-cluster-name
  namespace: mongodb-atlas-system
spec:
  projectRef:
    name: development
  serverlessSpec:
    name: serverless-instance
    tags:
    - key: "environment"
      value: "production"
    providerSettings:
      providerName: AWS
      regionName: US_EAST_1

Exemplo de cluster multirregional

Os clusters podem abranger regiões e provedores de serviços em nuvem. Para saber mais, consulte Considerações.

Observação

Enquanto o Atlas Cluster API Resource envia solicitações usando as versões daAPI v1.5 do Atlas , o campo Atlas Kubernetes Operator apiVersion usa v1. Nesse caso, v1 refere-se à versão da API do Kubernetes.

O exemplo seguinte mostra uma especificação de recurso personalizada do AtlasDeployment configurada para cluster multirregional:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - zoneName: Zone 1
        regionConfigs:
        priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1

Exemplo de vários provedores de serviços em cloud

O exemplo a seguir mostra uma especificação de recurso personalizada AtlasDeployment configurada para abranger vários provedores de serviços de cloud:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
spec:
  projectRef:
    name: my-project
  deploymentSpec:
    clusterType: REPLICASET
    name: tenantCluster
    tags:
    - key: "environment"
      value: "production"
    replicationSpecs:
      - regionConfigs:
        - electableSpecs:
            instanceSize: M10
            nodeCount: 3
          providerName: AWS
          regionName: US_EAST_1
          priority: 7
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: AZURE
          regionName: US_EAST_2
          priority: 6
        - electableSpecs:
            instanceSize: M10
            nodeCount: 2
          providerName: GCP
          regionName: CENTRAL_US
          priority: 5

Exemplo de índice Atlas Search

O exemplo seguinte mostra uma especificação de recurso personalizado AtlasDeployment configurada para criar um índice de Atlas Search para a coleção listingsAndReviews e grades:

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchIndexes:
    - DBName: sample_training
      collectionName: grades
      name: test-vector-search-index
      type: vectorSearch
      vectorSearch:
        fields:
        - numDimensions: 1000
          path: student_id
          similarity: euclidean
          type: vector
    - DBName: sample_airbnb
      collectionName: listingsAndReviews
      name: my-index
      search:
        mappings:
          dynamic: true
        searchConfigurationRef:
          name: atlassearchindexconfig-sample
          namespace: mongodb-atlas-system
      type: search
    terminationProtectionEnabled: false
  projectRef:
    name: my-project
    namespace: mongodb-atlas-system

Exemplo de nós Atlas Search

O exemplo seguinte mostra uma especificação de recurso personalizado do AtlasDeployment configurada para criar nós de Atlas Search :

apiVersion: atlas.mongodb.com/v1
kind: AtlasDeployment
metadata:
  name: my-atlas-cluster
  namespace: mongodb-atlas-system
spec:
  deploymentSpec:
    backupEnabled: true
    clusterType: REPLICASET
    name: Test-cluster-M10
    replicationSpecs:
    - regionConfigs:
      - backingProviderName: AWS
        electableSpecs:
          instanceSize: M10
          nodeCount: 3
        priority: 7
        providerName: AWS
        regionName: US_EAST_1
      zoneName: Zone 1
    searchNodes:
    - instanceSize: S20_HIGHCPU_NVME
      nodeCount: 2

Parâmetros

Sistema Atlas

AtlasDeployment é o esquema da API atlasdeployments

`Name`	Tipo	Descrição	Obrigatório
`apiVersion`	string	atlas.mongodb.com/v1	true
`kind`	string	`AtlasDeployment`	true
`metadata`	objeto	Consulte a documentação do Kubernetes `API` para os campos do campo `metadata`.	true
`spec`	objeto	`AtlasDeploymentSpec` define o estado alvo de `AtlasDeployment`. Apenas um de `DeploymentSpec`, `AdvancedDeploymentSpec` e `ServerlessSpec` deve ser definido. Validações: (has(auto.''externalProjectRef'') && !has(auto.''projectRef'')) \|\| (!has(auto.''externalProjectRef'') && has(auto.``projectRef``)): deve definir apenas uma referência do projeto por meio de `externalProjectRef` ou `projectRef` (has(auto.''externalProjectRef'') && has(auto.``connectionSecret``)) \|\| !has(auto.''externalProjectRef''): deve definir um segredo de conexão local ao fazer referência a um projeto externo !has(auto.''serverlessSpec'') \|\| (`oldSelf`.``hasValue``() && `oldSelf`.value().``serverlessSpec`` != null): `serverlessSpec` não pode ser adicionado - instâncias sem servidor estão obsoletas	false
`status`	objeto	`AtlasDeploymentStatus` define o estado observado de `AtlasDeployment`.	false

AtlasDeployment.spec

AtlasDeploymentSpec define o estado de destino do AtlasDeployment. Somente um entre DeploymentSpec, AdvancedDeploymentSpec e ServerlessSpec deve ser definido.

`Name`	Tipo	Descrição	Obrigatório
`backupRef`	objeto	Referência ao agendar de backup para o `AtlasDeployment`.	false
`connectionSecret`	objeto	Nome do segredo contendo as chaves privada e pública do Atlas `API`.	false
`deploymentSpec`	objeto	Configuração para o avançado (v1.5) implantação `API` https://www.mongodb.com/pt-br/docs/atlas/reference/api/clusters/	false
`externalProjectRef`	objeto	`externalProjectRef` contém o projeto principal do Atlas `ID`. Mutualmente exclusivo com o campo"`projectRef`".	false
`flexSpec`	objeto	Configuração do cluster flexível `API`. https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters	false
`processArgs`	objeto	`ProcessArgs` permite a modificação de Opções de configuração avançadas.	false
`projectRef`	objeto	`projectRef` é uma referência ao recurso pai `AtlasProject`. Mutualmente exclusivo com o campo"`externalProjectRef`".	false
`serverlessSpec`	objeto	Configuração para a implantação sem servidor `API`. https://www.mongodb.com/pt-br/docs/atlas/reference/api/serverless-instances/ `DEPRECATED`: As instâncias sem servidor estão obsoletas. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obter detalhes.	false
`upgradeToDedicated`	booleano	`upgradeToDedicated`, quando definido como true, aciona a migração de um cluster flexível para um cluster dedicado. O usuário `MUST` fornece a nova configuração de cluster dedicado . Esse sinalizador será ignorado se o cluster já for dedicado.	false

AtlasDeployment.spec.backupRef

Referência ao agendar de backup para o AtlasDeployment.

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome do Recurso Kubernetes	true
`namespace`	string	Namespace do Recurso Kubernetes	false

AtlasDeployment.spec.connectionSecret

Nome do segredo que contém as chaves privadas e públicas da Atlas API.

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome do recurso que está sendo referenciado Mais informações: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names	true

AtlasDeployment.spec.deploymentSpec

Configuração para o avançado (v1.5) API de implantação https://www.mongodb.com/pt-br/docs/atlas/reference/api/clusters/

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome da implantação avançada conforme aparece no Atlas. Depois que o Atlas cria a implantação, você não pode alterar seu nome. Só pode conter `ASCII` letras, números e hifens. Validações: self == `oldSelf`: o nome não pode ser modificado após a criação da implantação	true
`backupEnabled`	booleano	Sinalizador que indica se a implantação usa backups em nuvem para backup. Aplicável somente para implantações M10''+.	false
`biConnector`	objeto	Configuração do Connector `BI` para Atlas nesta implantação. O `MongoDB` Connector for Business Intelligence for Atlas (`BI` Connector) só está disponível para implantações `M10` e maiores.	false
`clusterType`	enum	Tipo da implantação que você deseja criar. O parâmetro é exigido se `replicationSpecs` estiver configurado ou se Implantação Global for implantada. enumeração: `REPLICASET`, `SHARDED`, `GEOSHARDED`	false
`configServerManagementMode`	enum	Modo de gerenciamento do servidor de configuração para criar ou atualizar um cluster fragmentado. enumeração: `ATLAS_MANAGED`, `FIXED_TO_DEDICATED`	false
`customZoneMapping`	[] objeto	Lista que contém parâmetros do Cluster Global que mapeia zonas para regiões geográficas.	false
`diskSizeGB`	inteiro	Capacidade, em gigabytes, do volume raiz do hospedar. Aumente esse número para adicionar capacidade, até um valor máximo possível de 4096 (ou seja, 4 `TB`). Esse valor deve ser um número inteiro positivo. O parâmetro é necessário se `replicationSpecs` estiver configurado. Mínimo: 0 Máximo: 4096	false
`encryptionAtRestProvider`	enum	Provedor de serviços de nuvem que oferece criptografia em descanso. enumeração: `AWS`, `GCP`, `AZURE`, `NONE`	false
`labels`	[] objeto	Coleção de pares de chave-valor que tagueiam e categorizam a implantação. Cada chave e valor tem um comprimento máximo de 255 caracteres. `DEPRECATED`: os clusters `labels` estão obsoletos e serão removidos em uma versão futura. Em vez disso, é altamente recomendável usar tags de recursos.	false
`managedNamespaces`	[] objeto	Lista que contém informações para criar um namespace gerenciado em um cluster global especificado a ser criado.	false
`mongoDBMajorVersion`	string	`MongoDB` versão principal do cluster. Defina para a versão binária principal.	false
`mongoDBVersion`	string	Versão do `MongoDB` que o cluster executa.	false
`paused`	booleano	Sinalizador que indica se a implantação deve ser pausada.	false
`pitEnabled`	booleano	Sinalizador que indica que a implantação usa backups contínuos em nuvem.	false
`replicationSpecs`	[] objeto	Configuração para regiões de implantação.	false
`rootCertType`	string	Autoridade de certificação raiz que o cluster `MongoDB` do Atlas utiliza.	false
`searchIndexes`	[] objeto	Uma array de `SearchIndex` objetos com campos que descrevem o índice de pesquisa.	false
`searchNodes`	[] objeto	Configurações para nós de pesquisa para o cluster. Atualmente, no máximo uma configuração de nó de pesquisa pode ser definida.	false
`tags`	[] objeto	Pares de valores-chave para tag de recursos.	false
`terminationProtectionEnabled`	booleano	Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como verdadeiro, a `MongoDB` nuvem não excluirá o cluster. Se definido como falso, `MongoDB` a nuvem excluirá o cluster. Padrão: false	false
`versionReleaseSystem`	string	Método pelo qual o cluster mantém as versões do `MongoDB`. Se o valor for `CONTINUOUS`, você não deverá especificar `mongoDBMajorVersion`.	false

AtlasDeployment.spec.deploymentSpec.biConnector

Configuração do BI Connector para o Atlas nesta implantação. O MongoDB Connector for Business Intelligence for Atlas (BI Connector) só está disponível para implantações M10 e maiores.

`Name`	Tipo	Descrição	Obrigatório
`enabled`	booleano	Sinalizador que indica se o Business Intelligence Connector for Atlas está `enabled` na implantação.	false
`readPreference`	string	Fonte da qual o Connector `BI` para Atlas lê dados. Cada preferência de leitura do Connector para Atlas `BI` contém uma combinação distinta de opções `readPreference` e `readPreferenceTags`.	false

AtlasDeployment.spec.deploymentSpec.customZoneMapping

`Name`	Tipo	Descrição	Obrigatório
`location`	string	Código que representa um `location` que mapeia para uma zona em seu cluster global. `MongoDB` O Atlas representa este `location` com um `ISO` 3166-2 `location` e códigos de subdivisão quando possível.	true
`zone`	string	Etiqueta legível por humanos que identifica o `zone` em seu cluster global. Este `zone` mapeia para um código de localização.	true

AtlasDeployment.spec.deploymentSpec.labels

O LabelSpec contém pares de valores-chave que tagueiam e categorizam o cluster/DBUser

`Name`	Tipo	Descrição	Obrigatório
`key`	string	Chave aplicada para marcar e categorizar este componente.	true
`value`	string	Valor definido para a chave aplicada para marcar e categorizar este componente.	true

AtlasDeployment.spec.deploymentSpec.managedNamespaces

ManagedNamespace representa as informações sobre a configuração do namespace gerenciado.

`Name`	Tipo	Descrição	Obrigatório
`collection`	string	Etiqueta legível por humanos do `collection` a ser gerenciado para este cluster global.	true
`db`	string	Etiqueta legível para humanos do banco de dados a ser gerenciado para este cluster global.	true
`customShardKey`	string	Parâmetro do banco de dados utilizado para dividir a coleção em fragmentos. Clusters globais exigem uma chave de shard composta. Essa chave de shard composta combina o parâmetro de localização e a chave personalizada selecionada pelo usuário.	false
`isCustomShardKeyHashed`	booleano	Sinalizador que indica se alguém aplicou com hash a chave de fragmento personalizada para a coleção especificada. Se você definir esse valor como falso, a `MongoDB` nuvem usará fragmentação à distância.	false
`isShardKeyUnique`	booleano	Sinalizador que indica se alguém com hash da chave de fragmento personalizada. Se este parâmetro retornar falso, este cluster usará fragmentação à distância.	false
`numInitialChunks`	inteiro	Número mínimo de partes a serem criadas inicialmente ao realizar a fragmentação de uma coleção vazia com uma chave de fragmento com hash. O valor máximo é 8192.	false
`presplitHashedZones`	booleano	Sinalizador que indica se a `MongoDB` nuvem deve criar e distribuir partes iniciais para uma coleção vazia ou inexistente. O `MongoDB` Nuvem distribui dados com base nas zonas e faixas de zona definidos para a coleção.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs

`Name`	Tipo	Descrição	Obrigatório
`numShards`	inteiro	Inteiro positivo que especifica o número de fragmentos a serem implantados em cada zona especificada. Se você definir esse valor como 1 e `clusterType` for `SHARDED`, `MongoDB` a nuvem implanta um cluster de fragmento único. Não crie um cluster fragmentado com um único fragmento para ambientes de produção. Os clusters de fragmentos únicos não oferecem os mesmos benefícios que as configurações de vários fragmentos	false
`regionConfigs`	[] objeto	Especificações de hardware para nós definidos para uma determinada região. Cada objeto `regionConfigs` descreve a prioridade da região nas eleições e o número e tipo de nós `MongoDB` que o `MongoDB` Cloud implanta na região. Cada objeto `regionConfigs` deve ter um objeto `analyticsSpecs` , `electableSpecs` objeto ou `readOnlySpecs` objeto. Os clusters de locatários exigem apenas `electableSpecs`. Os clusters dedicados podem especificar qualquer uma dessas especificações, mas devem ter pelo menos um objeto `electableSpecs` dentro de um `replicationSpec`. Cada especificação de hardware deve usar o mesmo `instanceSize`.	false
`zoneName`	string	Etiqueta legível por humanos que identifica a zona em um cluster global.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs

`Name`	Tipo	Descrição	Obrigatório
`analyticsSpecs`	objeto	Especificações de hardware para nós de análise implantados na região.	false
`autoScaling`	objeto	Opções que determinam como esse cluster lida com o dimensionamento de recursos.	false
`backingProviderName`	enum	Provedor de serviços de nuvem no qual o host para uma implantação multilocatária é provisionado. Esta configuração só funciona quando "`providerName`" : "`TENANT`" e "`providerSetting`.``instanceSizeName``" : `M2` ou `M5`. Caso contrário, deve ser igual ao valor "`providerName`". enumeração: `AWS`, `GCP`, `AZURE`	false
`electableSpecs`	objeto	Especificações de hardware para nós distribuídos na região.	false
`priority`	inteiro	É dada precedência a esta região quando ocorre uma eleição primária. Se o seu `regionConfigs` tiver apenas `readOnlySpecs`, `analyticsSpecs` ou ambos, defina este valor para 0. Se você tiver vários objetos `regionConfigs` (seu cluster é multirregional ou multinuvem), eles deverão ter prioridades em ordem decrescente. O `priority` mais alto é 7	false
`providerName`	enum	Enum: `AWS`, `GCP`, `AZURE`, `TENANT`, `SERVERLESS`	false
`readOnlySpecs`	objeto	Especificações de hardware para nós somente leitura implantados na região.	false
`regionName`	string	Localização física da sua implantação do `MongoDB`. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.analyticsSpecs

Especificações de hardware para nós de análise implantados na região.

`Name`	Tipo	Descrição	Obrigatório
`diskIOPS`	inteiro	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. Formato: int64	false
`ebsVolumeType`	enum	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. enumeração: `STANDARD`, `PROVISIONED`	false
`instanceSize`	string	Especificação de hardware para os tamanhos de instância nesta região. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. O tamanho da instância selecionado se aplica a todos os hosts portadores de dados no tamanho da instância.	false
`nodeCount`	inteiro	Número de nós do tipo fornecido para a `MongoDB` nuvem implantar na região.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling

Opções que determinam como esse cluster lida com o dimensionamento de recursos.

`Name`	Tipo	Descrição	Obrigatório
`compute`	objeto	Coleção de configurações que configuram como uma implantação pode dimensionar seu nível de implantação e se a implantação pode dimensionar para baixo.	false
`diskGB`	objeto	Sinalizador que indica se o dimensionamento automático de disco está habilitado. O padrão é verdadeiro.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute

Coleção de configurações que configuram como uma implantação pode dimensionar seu nível de implantação e se a implantação pode dimensionar para baixo.

`Name`	Tipo	Descrição	Obrigatório
`enabled`	booleano	Sinalizador que indica se o dimensionamento automático do nível de implantação está habilitado. O padrão é "falso".	false
`maxInstanceSize`	string	Tamanho máximo da instância para a qual sua implantação pode dimensionar automaticamente (como `M40`). O Atlas exige este parâmetro se "`autoScaling`.compute.enabled" : verdadeiro.	false
`minInstanceSize`	string	Tamanho mínimo da instância para a qual sua implantação pode dimensionar automaticamente (como `M10`). O Atlas exige este parâmetro se "`autoScaling`.compute.``scaleDownEnabled``" : verdadeiro.	false
`scaleDownEnabled`	booleano	Sinalizador que indica se o nível de implantação pode dimensionar para baixo. O Atlas exige este parâmetro se "`autoScaling`.compute.enabled" : verdadeiro.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB

Sinalizador que indica se o dimensionamento automático de disco está habilitado. O padrão é verdadeiro.

`Name`	Tipo	Descrição	Obrigatório
`enabled`	booleano	Sinalizador que indica se este cluster habilita o auto-scaling de disco. A memória máxima permitida para a camada do cluster selecionada e o tamanho do oplog podem limitar o auto-scaling de armazenamento.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.electableSpecs

Especificações de hardware para nós distribuídos na região.

`Name`	Tipo	Descrição	Obrigatório
`diskIOPS`	inteiro	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. Formato: int64	false
`ebsVolumeType`	enum	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. enumeração: `STANDARD`, `PROVISIONED`	false
`instanceSize`	string	Especificação de hardware para os tamanhos de instância nesta região. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. O tamanho da instância selecionado se aplica a todos os hosts portadores de dados no tamanho da instância.	false
`nodeCount`	inteiro	Número de nós do tipo fornecido para a `MongoDB` nuvem implantar na região.	false

AtlasDeployment.spec.deploymentSpec.replicationSpecs.regionConfigs.readOnlySpecs

Especificações de hardware para nós somente leitura implantados na região.

`Name`	Tipo	Descrição	Obrigatório
`diskIOPS`	inteiro	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. Formato: int64	false
`ebsVolumeType`	enum	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. enumeração: `STANDARD`, `PROVISIONED`	false
`instanceSize`	string	Especificação de hardware para os tamanhos de instância nesta região. Cada tamanho de instância tem uma capacidade de armazenamento e memória padrão. O tamanho da instância selecionado se aplica a todos os hosts portadores de dados no tamanho da instância.	false
`nodeCount`	inteiro	Número de nós do tipo fornecido para a `MongoDB` nuvem implantar na região.	false

AtlasDeployment.spec.deploymentSpec.searchIndexes

SearchIndex é o CRD para configurar parte do índice do Atlas Search.

`Name`	Tipo	Descrição	Obrigatório
`DBName`	string	Rótulo legível por humanos que identifica o banco de dados que contém a collection com um ou mais índices do Atlas Search.	true
`collectionName`	string	Rótulo legível por humanos que identifica a coleção que contém um ou mais índices do Atlas Search.	true
`name`	string	Rótulo legível por humanos que identifica este índice. Deve ser exclusivo para um sistema.	true
`type`	enum	Tipo de índice. enumeração: pesquisa, `vectorSearch`	true
`search`	objeto	Configuração de índice do Atlas `search`.	false
`vectorSearch`	objeto	Configuração do índice de pesquisa vetorial do Atlas.	false

AtlasDeployment.spec.deploymentSpec.searchIndexes.search

Configuração do índice do Atlas índice de pesquisa .

`Name`	Tipo	Descrição	Obrigatório
`mappings`	objeto	Especificações de índice para os campos da collection.	true
`searchConfigurationRef`	objeto	Uma referência ao recurso personalizado `AtlasSearchIndexConfig`.	true
`synonyms`	[] objeto	Conjuntos de regras que mapeiam palavras para suas `synonyms` neste índice.	false

AtlasDeployment.spec.deploymentSpec.searchIndexes.pesquisa.mappings

Especificações de índice para os campos da collection.

`Name`	Tipo	Descrição	Obrigatório
`dynamic`	`JSON`	Indica se o índice utiliza mapeamentos estáticos, dinâmicos padrão ou `dynamic` configuráveis. Defina como true para ativar o mapeamento `dynamic` com o conjunto de tipos padrão ou definir objeto para especificar o nome dos conjuntos de tipos configurados para o mapeamento `dynamic`. Se você especificar mapeamentos `dynamic` configuráveis, deverá definir os conjuntos de tipos mencionados no campo ``typeSets``. Defina como falso para usar somente mapeamentos estáticos por meio de mapeamentos.campos.	false
`fields`	`JSON`	Uma ou mais especificações de campo para o índice do Atlas Search. Obrigatório se map.dynamic for omitido ou definido como false.	false

AtlasDeployment.spec.deploymentSpec.pesquisaIndexes.pesquisa.pesquisaConfigurationRef

Uma referência ao recurso personalizado AtlasSearchIndexConfig.

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome do Recurso Kubernetes	true
`namespace`	string	Namespace do Recurso Kubernetes	false

AtlasDeployment.spec.deploymentSpec.searchIndexes.pesquisa.pesquisa

Sinônimo representa o tipo "Sinônimo" do índice Atlas Search.

`Name`	Tipo	Descrição	Obrigatório
`analyzer`	enum	Método pré-definido específico escolhido para aplicar aos sinônimos para pesquisa. enumeração: lucene.standard, lucene.simple, lucene.whitespace, lucene.keyword, lucene.arabic, lucene.armenian, lucene.basque, lucene.bengali, lucene.brazilian, lucene.bulgarian, lucene.catalan, lucene.chinese, lucene.cjk, lucene.czech, lucene.danish, lucene.dutch, lucene.english, lucene.finnish, lucene.french, lucene.galician, lucene.german, lucene.greek, lucene.hindi, lucene.hungarian, lucene.indonesian, lucene.irish, lucene.italian, lucene.japanese, lucene.korean, lucene.kuromoji, lucene.latvian, lucene.lithuanian, lucene.morfologik, lucene.nori, lucene.norwegian, lucene.persian, lucene.portuguese, lucene.romanian, lucene.russian, lucene.smartcn, lucene.sorani, lucene.spanish, lucene.swedish, lucene.thai, lucene.turkish, lucene.ukrainian	true
`name`	string	Etiqueta legível por humanos que identifica a definição de sinônimo. Cada `name` deve ser exclusivo dentro da mesma definição de índice.	true
`source`	objeto	Conjunto de dados que armazena o mapeamento de uma ou mais palavras para um ou mais sinônimos dessas palavras.	true

AtlasDeployment.spec.deploymentSpec.searchIndexes.pesquisa.synonyms.source

Conjunto de dados que armazena o mapeamento de uma ou mais palavras para um ou mais sinônimos dessas palavras.

`Name`	Tipo	Descrição	Obrigatório
`collection`	string	Etiqueta legível por humanos que identifica o `MongoDB` `collection` que armazena palavras e seus sinônimos aplicáveis.	true

AtlasDeployment.spec.deploymentSpec.searchIndexes.vectorSearch

Configuração do índice de pesquisa vetorial do Atlas.

`Name`	Tipo	Descrição	Obrigatório
`fields`	`JSON`	Array de `JSON` objetos. Consulte exemplos https://dochub.mongodb.org/core/avs-vector-type	true

AtlasDeployment.spec.deploymentSpec.searchNodes

`Name`	Tipo	Descrição	Obrigatório
`instanceSize`	enum	Especificação de hardware para os tamanhos de instância do nó de pesquisa. enumeração: `S20_HIGHCPU_NVME`, `S30_HIGHCPU_NVME`, `S40_HIGHCPU_NVME`, `S50_HIGHCPU_NVME`, `S60_HIGHCPU_NVME`, `S70_HIGHCPU_NVME`, `S80_HIGHCPU_NVME`, `S30_LOWCPU_NVME`, `S40_LOWCPU_NVME`, `S50_LOWCPU_NVME`, `S60_LOWCPU_NVME`, `S80_LOWCPU_NVME`, `S90_LOWCPU_NVME`, `S100_LOWCPU_NVME`, `S110_LOWCPU_NVME`	false
`nodeCount`	inteiro	Número de nós de pesquisa no cluster. Mínimo: 2 Máximo: 32	false

AtlasDeployment.spec.deploymentSpec.tags

O TagSpec contém um par de valores-chave para tag de recursos nesta implantação.

`Name`	Tipo	Descrição	Obrigatório
`key`	string	Constante que define o conjunto da tag.	true
`value`	string	Variável que pertence ao conjunto da tag.	true

AtlasDeployment.spec.externalProjectRef

externalProjectRef contém o ID do grupo pai do Atlas. Mutualmente exclusivo com o campo"projectRef".

`Name`	Tipo	Descrição	Obrigatório
`id`	string	`ID` é o projeto Atlas `ID`.	true

AtlasDeployment.spec.flexSpec

Configuração da API do cluster Flex. https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Flex-Clusters

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Rótulo legível por humanos que identifica a instância.	true
`providerSettings`	objeto	Grupo de configurações do provedor de nuvem que configuram o cluster flexível `MongoDB` com provisionamento.	true
`tags`	[] objeto	Lista que contém pares de valores-chave entre 1 e 255 caracteres de comprimento para marcar e categorizar a instância.	false
`terminationProtectionEnabled`	booleano	Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como verdadeiro, a `MongoDB` nuvem não excluirá o cluster. Se definido como falso, `MongoDB` a nuvem excluirá o cluster. Padrão: false	false

AtlasDeployment.spec.flexSpec.providerSettings

Grupo de configurações do provedor de nuvem que configuram o cluster flex do MongoDB provisionado.

`Name`	Tipo	Descrição	Obrigatório
`backingProviderName`	enum	Provedor de serviços de nuvem no qual o Atlas `MongoDB` provisiona o cluster flex. Validações: self == `oldSelf`: o Provedor de apoio não pode ser modificado após a criação do cluster Enum: `AWS`, `GCP`, `AZURE`	true
`regionName`	string	Etiqueta legível por humanos que identifica a localização geográfica do seu cluster flex `MongoDB`. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Validações: self == `oldSelf`: o nome da região não pode ser modificado após a criação do cluster	true

AtlasDeployment.spec.flexSpec.tags

O TagSpec contém um par de valores-chave para tag de recursos nesta implantação.

`Name`	Tipo	Descrição	Obrigatório
`key`	string	Constante que define o conjunto da tag.	true
`value`	string	Variável que pertence ao conjunto da tag.	true

AtlasDeployment.spec.processArgs

ProcessArgs permite a modificação de opções de configuração avançadas.

`Name`	Tipo	Descrição	Obrigatório
`defaultReadConcern`	string	String que indica o nível padrão de confirmação solicitado do `MongoDB` para operações de leitura configuradas para este cluster.	false
`defaultWriteConcern`	string	String que indica o nível padrão de confirmação solicitado do `MongoDB` para operações de gravação configuradas para este cluster.	false
`failIndexKeyTooLong`	booleano	Sinalizador que indica se a operação deve falhar e retornar um erro ao inserir ou atualizar documentos em que todas as entradas de índice excedam 1024 bytes. Se você definir essa opção como falsa, o mongod gravará os documentos que excederem esse limite, mas não os indexa.	false
`javascriptEnabled`	booleano	Sinalizador que indica se o cluster permite a execução de operações que executam execuções do lado do servidor de `JavaScript`.	false
`minimumEnabledTlsProtocol`	string	String que indica a versão mínima `TLS` que o cluster aceita para conexões de entrada. Os clusters que usam `TLS` 1.0 ou 1.1 devem considerar a configuração do `TLS` 1.2 como a versão mínima do protocolo `TLS`.	false
`noTableScan`	booleano	Flag que indica se o cluster desativa a execução de qualquer query que exija uma varredura de coleção para retornar resultados.	false
`oplogMinRetentionHours`	string	Janela mínima de retenção para o oplog do cluster expressa em horas. Um valor nulo indica que o cluster usa a oplog window mínima padrão que a `MongoDB` nuvem calcula.	false
`oplogSizeMB`	inteiro	Número que indica o limite de armazenamento do oplog de um cluster expresso em megabytes. Um valor nulo indica que o cluster usa o tamanho de oplog padrão que o Atlas calcula. Formato: int64	false
`sampleRefreshIntervalBIConnector`	inteiro	Número que indica os documentos por banco de dados a serem amostra ao coletar informações de esquema. Formato: int64	false
`sampleSizeBIConnector`	inteiro	Número que indica o intervalo, em segundos, no qual o processo mongosqld faz uma nova amostra dos dados para criar seu esquema relacional. Formato: int64	false

AtlasDeployment.spec.projectRef

projectRef é uma referência ao recurso pai AtlasProject. Mutualmente exclusivo com o campo"externalProjectRef".

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome do Recurso Kubernetes	true
`namespace`	string	Namespace do Recurso Kubernetes	false

AtlasDeployment.spec.serverlessSpec

Configuração para a API de implantação sem servidor. https://www.mongodb.com/pt-br/docs/atlas/reference/api/serverless-instances/ Obsoleto: as instâncias sem servidor estão obsoletas. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obter detalhes.

`Name`	Tipo	Descrição	Obrigatório
`name`	string	Nome da implantação sem servidor como aparece no Atlas. Depois que o Atlas cria a implantação, você não pode alterar seu nome. Só pode conter `ASCII` letras, números e hifens.	true
`providerSettings`	objeto	Configuração dos hospedar provisionados nos quais o `MongoDB` é executado. As opções disponíveis são específicas para o provedor de serviços de nuvem.	true
`backupOptions`	objeto	serverlessBackupOptions	false
`privateEndpoints`	[] objeto	Lista que contém as configurações de pontos de extremidade privados para a instância sem servidor. `DEPRECATED`: os pontos de extremidade privados sem servidor estão obsoletos. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obter detalhes.	false
`tags`	[] objeto	Pares de valores-chave para tag de recursos.	false
`terminationProtectionEnabled`	booleano	Sinalizador que indica se a proteção de rescisão está habilitada no cluster. Se definido como verdadeiro, a `MongoDB` nuvem não excluirá o cluster. Se definido como falso, `MongoDB` a nuvem excluirá o cluster. Padrão: false	false

AtlasDeployment.spec.serverlessSpec.providerSettings

Configuração para os hospedeiros provisionados nos quais o MongoDB é executado. As opções disponíveis são específicas para o provedor de serviços de nuvem.

`Name`	Tipo	Descrição	Obrigatório
`providerName`	enum	Provedor de serviços de nuvem no qual o Atlas provisiona os hosts. enumeração: `AWS`, `GCP`, `AZURE`, `TENANT`, `SERVERLESS`	true
`autoScaling`	objeto	Faixa de tamanhos de instâncias para os quais sua implantação pode ser dimensionada. `DEPRECATED`: o valor deste campo não tem efeito.	false
`backingProviderName`	enum	Provedor de serviços de nuvem no qual o host para uma implantação multilocatária é provisionado. Esta configuração só funciona quando "`providerSetting`.``providerName``" : "`TENANT`" e "`providerSetting`.``instanceSizeName``" : `M2` ou `M5`. enumeração: `AWS`, `GCP`, `AZURE`	false
`diskIOPS`	inteiro	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. `DEPRECATED`: O valor deste campo não tem nenhum efeito. Formato: int64	false
`diskTypeName`	string	Tipo de disco se você selecionou o Azure como seu provedor de serviços de nuvem. `DEPRECATED`: o valor deste campo não tem efeito.	false
`encryptEBSVolume`	booleano	Sinalizador que indica se o recurso de criptografia do Amazon `EBS` criptografa o volume raiz do hospedar para dados em repouso no volume e para movimentação de dados entre o volume e a implantação. `DEPRECATED`: o valor deste campo não tem nenhum efeito.	false
`instanceSizeName`	string	O Atlas oferece diferentes níveis de implantação, cada um com uma capacidade de armazenamento padrão e tamanho `RAM`. A implantação selecionada é usada para todos os hosts portadores de dados em seu nível de implantação. `DEPRECATED`: o valor deste campo não tem nenhum efeito.	false
`regionName`	string	Localização física da sua implantação do `MongoDB`. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados.	false
`volumeType`	enum	Configuração de disco `IOPS` para armazenamento `AWS`. Defina somente se você selecionou `AWS` como seu provedor de serviços de nuvem. `DEPRECATED`: O valor deste campo não tem nenhum efeito. enumeração: `STANDARD`, `PROVISIONED`	false

AtlasDeployment.spec.serverlessSpec.providerSettings.autoScaling

Faixa de tamanhos de instâncias para os quais sua implantação pode ser dimensionada. OBSERVE: o valor deste campo não tem nenhum efeito.

`Name`	Tipo	Descrição	Obrigatório
`autoIndexingEnabled`	booleano	Sinalizador que indica se o modo de motorista automático para o Performance Advisor está habilitado. O padrão é "falso". `DEPRECATED`: esse sinalizador não é mais suportado.	false
`compute`	objeto	Coleção de configurações que configuram como uma implantação pode dimensionar seu nível de implantação e se a implantação pode dimensionar para baixo.	false
`diskGBEnabled`	booleano	Sinalizador que indica se o dimensionamento automático de disco está habilitado. O padrão é verdadeiro.	false

AtlasDeployment.spec.serverlessSpec.providerSettings.autoScaling.compute

Coleção de configurações que configuram como uma implantação pode dimensionar seu nível de implantação e se a implantação pode dimensionar para baixo.

`Name`	Tipo	Descrição	Obrigatório
`enabled`	booleano	Sinalizador que indica se o dimensionamento automático do nível de implantação está habilitado. O padrão é "falso".	false
`maxInstanceSize`	string	Tamanho máximo da instância para a qual sua implantação pode dimensionar automaticamente (como `M40`). O Atlas exige este parâmetro se "`autoScaling`.compute.enabled" : verdadeiro.	false
`minInstanceSize`	string	Tamanho mínimo da instância para a qual sua implantação pode dimensionar automaticamente (como `M10`). O Atlas exige este parâmetro se "`autoScaling`.compute.``scaleDownEnabled``" : verdadeiro.	false
`scaleDownEnabled`	booleano	Sinalizador que indica se o nível de implantação pode dimensionar para baixo. O Atlas exige este parâmetro se "`autoScaling`.compute.enabled" : verdadeiro.	false

AtlasDeployment.spec.serverlessSpec.backupOptions

serverlessBackupOptions

`Name`	Tipo	Descrição	Obrigatório
`serverlessContinuousBackupEnabled`	booleano	`ServerlessContinuousBackupEnabled` indica se o cluster usa backups contínuos em nuvem. `DEPRECATED`: As instâncias sem servidor estão obsoletas e não suportam mais backup contínuo. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obter detalhes. Padrão: true	false

AtlasDeployment.spec.serverlessSpec.privateEndpoints

O ServerlessPrivateEndpoint configura pontos de extremidade privados para as instâncias sem servidor. Obsoleto: os pontos de extremidade privados sem servidor estão obsoletos. Consulte https://dochub.mongodb.org/core/atlas-flex-migration para obter detalhes.

`Name`	Tipo	Descrição	Obrigatório
`cloudProviderEndpointID`	string	`CloudProviderEndpointID` é o identificador do ponto de extremidade do provedor de nuvem.	false
`name`	string	Name é o `name` do serviço `PrivateLink` sem servidor. Deve ser único.	false
`privateEndpointIpAddress`	string	`PrivateEndpointIPAddress` é o endereço IPv4 do ponto de extremidade privado em sua VNet do Azure que alguém adicionou a esse serviço de pontos de extremidade privados.	false

AtlasDeployment.spec.serverlessSpec.tags

O TagSpec contém um par de valores-chave para tag de recursos nesta implantação.

`Name`	Tipo	Descrição	Obrigatório
`key`	string	Constante que define o conjunto da tag.	true
`value`	string	Variável que pertence ao conjunto da tag.	true

AtlasDeployment.status

AtlasDeploymentStatus define o estado observado do AtlasDeployment.

`Name`	Tipo	Descrição	Obrigatório
`conditions`	[] objeto	Condições é a lista de status que mostra o estado atual do Recurso Personalizado do Atlas	true
`connectionStrings`	objeto	`ConnectionStrings` é um conjunto de strings de conexão que seus aplicativos usam para se conectar a esse cluster.	false
`customZoneMapping`	objeto	Lista que contém pares de valores-chave para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização `ISO` 3166-1a2, com um código de subdivisão `ISO` 3166-2 quando possível, para uma string hexadecimal única 24que identifica a zona personalizada.	false
`managedNamespaces`	[] objeto	Lista que contém um namespace para um cluster global. `MongoDB` Atlas gerencia este cluster.	false
`mongoDBVersion`	string	`MongoDBVersion` é a versão do `MongoDB` que o cluster executa, em . formato.	false
`mongoURIUpdated`	string	`MongoURIUpdated` é um timestamp no formato de data e hora `ISO` 8601 no `UTC` quando a string de conexão foi atualizada pela última vez. A string de conexão muda se você atualizar qualquer um dos outros valores.	false
`observedGeneration`	inteiro	`ObservedGeneration` indica a geração da especificação de recurso da qual o Operador Atlas está ciente. O Operador do Atlas atualiza este campo para o valor de 'metadados.generation' assim que iniciar a reconciliação do recurso. Formato: int64	false
`replicaSets`	[] objeto	Detalhes que explicam como a `MongoDB` nuvem replica dados no banco de dados `MongoDB` especificado. Essa array tem um objeto por fragmento que representa as configurações de nó em cada fragmento. Para conjuntos de réplicas, há apenas um objeto que representa as configurações do nó.	false
`searchIndexes`	[] objeto	`SearchIndexes` contém uma lista de status de índices de pesquisa configurados para um projeto.	false
`serverlessPrivateEndpoints`	[] objeto	`ServerlessPrivateEndpoints` contém uma lista de pontos de extremidade privados configurados para a implantação sem servidor.	false
`stateName`	string	`StateName` é o estado atual do cluster. Os possíveis estados são: `IDLE`, `CREATING`, `UPDATING`, `DELETING`, `DELETED`, `REPAIRING`	false

AtlasDeployment.status. conditions

A condição descreve o estado de um recurso personalizado do Atlas em um determinado ponto.

`Name`	Tipo	Descrição	Obrigatório
`status`	string	Status da condição; um de verdadeiro, falso, desconhecido.	true
`type`	string	Tipo de condição do Atlas recurso.	true
`lastTransitionTime`	string	Última vez que a condição fez a transição de um status para outro. Representado no formato `ISO` 8601. Formato: data/hora	false
`message`	string	Um `message` fornecendo detalhes sobre a transição.	false
`reason`	string	O `reason` para a última transição da condição.	false

AtlasDeployment.status.connectionStrings

ConnectionStrings é um conjunto de strings de conexão que seus aplicativos usam para se conectar a esse cluster.

`Name`	Tipo	Descrição	Obrigatório
`private`	string	Strings de conexão mongodb:// conscientes de emparelhamento de ponto de extremidade de rede para cada ponto de extremidade da interface `VPC` que você configurou para se conectar a esse cluster. O Atlas retorna esse parâmetro somente se você tiver criado uma conexão de peering de rede com esse cluster.	false
`privateEndpoint`	[] objeto	Strings de conexão de pontos de extremidade privados. Cada objeto descreve as strings de conexão que você pode usar para se conectar a esse cluster por meio de um ponto de extremidade privado. O Atlas retorna esse parâmetro somente se você tiver implantado pontos de extremidade privados em todas as regiões para as quais implantou os nós desse cluster.	false
`privateSrv`	string	Strings de conexão mongodb+srv:// cientes de ponto de extremidade de emparelhamento de rede para cada ponto de extremidade da interface `VPC` que você configurou para conectar a este cluster. O Atlas retorna esse parâmetro somente se você tiver criado uma conexão de peering de rede com esse cluster. Use este formato `URI` se o seu driver oferecer suporte. Caso contrário, use `connectionStrings`.private.	false
`standard`	string	string de conexão pública mongodb:// para este cluster.	false
`standardSrv`	string	string de conexão pública mongodb+srv:// para este cluster.	false

AtlasDeployment.status.connectionStrings.privateEndpoint

Connection strings PrivateEndpoint. Cada objeto descreve as strings de conexão que você pode usar para se conectar a esse cluster por meio de um ponto de extremidade privado. O Atlas retorna esse parâmetro somente se você tiver implantado pontos de extremidade privados em todas as regiões para as quais implantou os nós desse cluster.

`Name`	Tipo	Descrição	Obrigatório
`connectionString`	string	string de conexão mongodb:// com reconhecimento de ponto de extremidade privado para este ponto de extremidade privado.	false
`endpoints`	[] objeto	Ponto de extremidade privado através do qual você se conecta ao Atlas quando utiliza `connectionStrings`.``privateEndpoint``[n].``connectionString`` ou `connectionStrings`.``privateEndpoint``[n].``srvConnectionString``.	false
`srvConnectionString`	string	String de conexão mongodb+srv:// com reconhecimento de ponto de extremidade privado para este ponto de extremidade privado.	false
`srvShardOptimizedConnectionString`	string	string de conexão compatível com pontos de extremidade privados otimizada para clusters fragmentados que usa o protocolo `mongodb+srv://` para se conectar à nuvem `MongoDB` por meio de um ponto de extremidade privado.	false
`type`	string	Tipo de processo `MongoDB` ao qual você se conecta com as strings de conexão que o Atlas retorna: • `MONGOD` para conjuntos de réplicas, ou • `MONGOS` para clusters fragmentados	false

AtlasDeployment.status.connectionStrings.privateEndpoint.pontos de extremidade

Ponto de extremidade através do qual você se conecta ao Atlas

`Name`	Tipo	Descrição	Obrigatório
`endpointId`	string	Identificador único do ponto de extremidade privado.	false
`ip`	string	Endereço `IP` privado da interface de rede de pontos de extremidade privados que você criou em sua VNet do Azure.	false
`providerName`	string	Provedor de nuvem para o qual você implantou o ponto de extremidade privado. O Atlas retorna `AWS` ou `AZURE`.	false
`region`	string	Região para a qual você implantou os pontos de extremidade privados.	false

AtlasDeployment.status.customZoneMapping

Lista que contém pares de valores-chave para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização ISO 3166-1a2, com um código de subdivisão ISO 3166-2 quando possível, para uma string hexadecimal 24exclusiva que identifica a zona personalizada.

`Name`	Tipo	Descrição	Obrigatório
`customZoneMapping`	map[string]string	Lista que contém pares de valores-chave para mapear zonas de regiões geográficas. Esses pares mapeiam um código de localização `ISO` 3166-1a2, com um código de subdivisão `ISO` 3166-2 quando possível, para uma string hexadecimal única 24que identifica a zona personalizada.	false
`zoneMappingErrMessage`	string	Mensagem de erro para mapeamento de zona personalizada com falha.	false
`zoneMappingState`	string	Status do mapeamento da zona personalizada.	false

AtlasDeployment.status.managedNamespaces

`Name`	Tipo	Descrição	Obrigatório
`collection`	string	Etiqueta legível por humanos do `collection` a ser gerenciado para este cluster global.	true
`db`	string	Etiqueta legível para humanos do banco de dados a ser gerenciado para este cluster global.	true
`customShardKey`	string	Parâmetro do banco de dados utilizado para dividir a coleção em fragmentos. Clusters globais exigem uma chave de shard composta. Essa chave de shard composta combina o parâmetro de localização e a chave personalizada selecionada pelo usuário.	false
`errMessage`	string	Mensagem de erro para um namespace gerenciado com falha.	false
`isCustomShardKeyHashed`	booleano	Sinalizador que indica se alguém aplicou com hash a chave de fragmento personalizada para a coleção especificada. Se você definir esse valor como falso, o `MongoDB` Atlas usará fragmentação à distância.	false
`isShardKeyUnique`	booleano	Sinalizador que indica se alguém com hash da chave de fragmento personalizada. Se este parâmetro retornar falso, este cluster usará fragmentação à distância.	false
`numInitialChunks`	inteiro	Número mínimo de chunks a serem criados inicialmente ao fragmentar uma collection vazia com uma hashed shard key.	false
`presplitHashedZones`	booleano	Sinalizador que indica se a `MongoDB` nuvem deve criar e distribuir partes iniciais para uma coleção vazia ou inexistente. O `MongoDB` Atlas distribui dados com base nas zonas e faixas de zonas definidas para a coleção.	false
`status`	string	Status do namespace gerenciado.	false

AtlasDeployment.status.replicaSets

`Name`	Tipo	Descrição	Obrigatório
`id`	string	String única de 24dígitos hexadecimais que identifica o objeto de replicação de um fragmento em um cluster.	true
`zoneName`	string	Etiqueta legível por humanos que descreve a zona à qual esse fragmento pertence em um cluster global.	false

AtlasDeployment.status.searchIndexes

`Name`	Tipo	Descrição	Obrigatório
`ID`	string	String única de 24dígitos hexadecimais que identifica este índice do Atlas Search .	true
`message`	string	Detalhes sobre o status do índice de pesquisa.	true
`name`	string	Rótulo legível por humanos que identifica este índice.	true
`status`	string	Condição do índice de pesquisa.	true

AtlasDeployment.status.serverlessPrivateEndpoints

`Name`	Tipo	Descrição	Obrigatório
`_id`	string	`ID` é o identificador do Serviço `PrivateLink` sem servidor.	false
`cloudProviderEndpointId`	string	`CloudProviderEndpointID` é o identificador do ponto de extremidade do provedor de nuvem.	false
`endpointServiceName`	string	`EndpointServiceName` é o nome do serviço de ponto de extremidade `PrivateLink` em `AWS`. Retorna nulo enquanto o serviço de ponto de extremidade está sendo criado.	false
`errorMessage`	string	`ErrorMessage` é a mensagem de erro se o serviço `PrivateLink` sem servidor falhar ao criar ou conectar.	false
`name`	string	Name é o `name` do serviço `PrivateLink` sem servidor. Deve ser único.	false
`privateEndpointIpAddress`	string	`PrivateEndpointIPAddress` é o endereço IPv4 do ponto de extremidade privado em sua VNet do Azure que alguém adicionou a esse serviço de pontos de extremidade privados.	false
`privateLinkServiceResourceId`	string	`PrivateLinkServiceResourceID` é o caminho relativo à raiz que identifica o Azure Private Link que a `MongoDB` nuvem gerencia. `MongoDB` A nuvem retorna nulo enquanto cria o serviço de ponto de extremidade.	false
`providerName`	string	`ProviderName` é uma etiqueta legível por humanos que identifica o provedor de nuvem. Os valores incluem `AWS` ou `AZURE`.	false
`status`	string	Status da conexão `AWS` sem servidor `PrivateLink`.	false

Voltar

Projeto Atlas

AtlasDatabaseUser