Menu Docs
Página inicial do Docs
/ /
Recursos personalizados da OpenAPI
Página inicial do Docs
/
Gestão
/
Atlas Kubernetes Operator
/
Recursos personalizados da OpenAPI
Página inicial do Docs
/
Gestão
/
Atlas Kubernetes Operator
/
Recursos personalizados da OpenAPI

FlexCluster Recurso personalizado

Parâmetros

FlexCluster

Um flexcluster, gerenciado pelo MongoDB Kubernetes Atlas Operator.

Name
Tipo
Descrição
Obrigatório

apiVersion

string

atlas.generated.mongodb.com/v1

true

kind

string

FlexCluster

true

metadata

objeto

Consulte a documentação do Kubernetes API para os campos do campo metadata.

true

spec

objeto

Especificação do flexcluster compatível com as seguintes versões:

  • v20250312

No máximo, uma versão spec pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Validações:

  • (has(auto.v20250312.``groupId``) && has(auto.``connectionSecretRef``)) || (!has(auto.v20250312.``groupId``): spec.``connectionSecretRef`` deve ser definido se spec.v20250312.``groupId`` estiver definido.

false

status

objeto

somente leitura observado mais recentemente status do flexcluster para a versão do recurso especificada. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

false

FlexCluster.spec

Especificação do flexcluster compatível com as seguintes versões:

  • v20250312

No máximo, uma especificação versionada pode ser especificada. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

connectionSecretRef

objeto

SENSITIVE FIELD Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

false

v20250312

objeto

A especificação do recurso flexcluster para a versão20250312 v. Validações:

  • (has(auto.''groupId'') && !has(auto.''groupRef'')) || (!has(auto.``groupId``) && has(auto.``groupRef``): groupId e groupRef são mutuamente exclusivos; apenas um deles pode ser definido

false

FlexCluster.spec.connectionSecretRef

Campo sensível

Referência a um segredo contendo as credenciais para configurar a conexão com o Atlas.

Name
Tipo
Descrição
Obrigatório

name

string

Nome do segredo que contém as credenciais do Atlas .

false

FlexCluster.spec.v20250312

A especificação do recurso flexcluster para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

entry

objeto

Os campos entry da especificação do recurso do flexcluster. Estes campos podem ser configurados para criar e atualizar flexclusters.

false

groupId

string

Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para recuperar todos os projetos aos quais o usuário autenticado tem acesso.

Observação

Grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os pontos de extremidade correspondentes usam o termo grupos.

Validações:

  • self == oldSelf: groupId não pode ser modificado após a criação

false

groupRef

objeto

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

false

FlexCluster.spec.v20250312.entry

Os campos de entrada da especificação do recurso do flexcluster. Estes campos podem ser configurados para criar e atualizar flexclusters.

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 valor-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 true, o MongoDB Cloud não excluirá o cluster. Se definido como false, MongoDB a nuvem excluirá o cluster.

false

FlexCluster.spec.v20250312.entry.providerSettings

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

Name
Tipo
Descrição
Obrigatório

backingProviderName

string

Provedor de serviços de nuvem no qual a MongoDB Cloud forneceu o cluster flexível.

true

regionName

string

Etiqueta legível para humanos que identifica a localização geográfica do seu MongoDB cluster flexível. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Para obter uma lista completa de nomes de regiões, consulte AWS, GCP e Azure.

true

FlexCluster.spec.v20250312.entry.tags

Par de valores-chave que marca e categoriza uma organização, projeto ou cluster do MongoDB Cloud. Por exemplo, environment : production.

Name
Tipo
Descrição
Obrigatório

key

string

Constante que define o conjunto da tag. Por exemplo, environment na marcação environment : production .

true

value

string

Variável que pertence ao conjunto da tag. Por exemplo, production na marcação environment : production .

true

FlexCluster.spec.v20250312.groupRef

Uma referência a um recurso "Grupo". O valor de "$.status.v20250312.id" será utilizado para definir "groupId". Mutualmente exclusivo com a propriedade"groupId".

Name
Tipo
Descrição
Obrigatório

name

string

Nome do recurso "Grupo".

false

FlexCluster.status

Status somente leitura observado mais recentemente do flexcluster para a versão do recurso especificada. Esses dados podem não estar atualizados e são preenchidos pelo sistema. Mais informações: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

Name
Tipo
Descrição
Obrigatório

conditions

[] objeto

Representa as últimas observações disponíveis do estado atual de um recurso.

false

v20250312

objeto

O último estado do Atlas observado do recurso flexcluster para a versão v20250312.

false

FlexCluster.status. conditions

Name
Tipo
Descrição
Obrigatório

status

string

Status da condição, um de verdadeiro, falso, desconhecido.

true

type

string

Tipo de condição.

true

lastTransitionTime

string

Última vez que a condição fez a transição de um status para outro. Formato: data/hora

false

message

string

Um message legível por humanos indicando detalhes sobre a transição.

false

observedGeneration

inteiro

observedGeneration representa o .metadata.generação em que a condição foi definida com base.

false

reason

string

O reason para a última transição da condição.

false

FlexCluster.status.v20250312

O último estado do Atlas observado do recurso flexcluster para a versão v20250312.

Name
Tipo
Descrição
Obrigatório

providerSettings

objeto

Grupo de configurações do provedor de nuvem que configuram o cluster flexível MongoDB com provisionamento.

true

backupSettings

objeto

Configuração de backup flexível.

false

clusterType

string

topologia de cluster flexível.

false

connectionStrings

objeto

Coleção de localizadores uniformes de recursos que ponto para o banco de dados MongoDB .

false

createDate

string

Data e hora em que MongoDB Cloud criou esta instância. Este parâmetro expressa seu valor no formato ISO 8601 em UTC.

false

groupId

string

String exclusiva de 24 caracteres hexadecimais que identifica o projeto.

false

id

string

String única de 24dígitos hexadecimais que identifica a instância.

false

mongoDBVersion

string

Versão do MongoDB que a instância executa.

false

name

string

Rótulo legível por humanos que identifica a instância.

false

stateName

string

Etiqueta legível para humanos que indica qualquer atividade atual que esteja sendo realizada neste cluster pelo plano de controle Atlas . Com exceção dos estados CREATING e DELETING, os clusters devem estar sempre disponíveis e ter um nó primário, mesmo quando em estados que indicam atividade contínua.

  • IDLE: o Atlas não está fazendo alterações neste cluster e pode-se presumir que todas as alterações solicitadas por meio do UI ou API foram aplicadas.

  • CREATING: um cluster que está sendo provisionado pela primeira vez retorna o estado CREATING até que esteja pronto para conexões. Certifique-se de que a IP lista de acesso e os DB usuários estejam configurados antes de tentar se conectar.

  • UPDATING: Uma alteração solicitada por meio de UI, API, AutoScaling ou outra atividade agendada está ocorrendo.

  • DELETING: o cluster está em processo de exclusão e será excluído em breve.

  • REPAIRING: Um ou mais nós no cluster estão sendo devolvidos ao serviço pelo plano de controle Atlas . Outros nós devem continuar fornecendo serviços normalmente.

false

versionReleaseSystem

string

Método pelo qual o cluster mantém as versões do MongoDB.

false

FlexCluster.status.v20250312.providerSettings

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

Name
Tipo
Descrição
Obrigatório

backingProviderName

string

Provedor de serviços de nuvem no qual a MongoDB Cloud forneceu o cluster flexível.

false

diskSizeGB

número

Capacidade de armazenamento disponível para o cluster flexível expressa em gigabytes.

false

providerName

string

Etiqueta legível por humanos que identifica o tipo de provedor.

false

regionName

string

Etiqueta legível para humanos que identifica a localização geográfica do seu MongoDB cluster flexível. A região escolhida pode afetar a latência da rede para os clientes que acessam seus bancos de dados. Para obter uma lista completa de nomes de regiões, consulte AWS, GCP e Azure.

false

FlexCluster.status.v20250312.backupSettings

Configuração de backup flexível.

Name
Tipo
Descrição
Obrigatório

enabled

booleano

Sinalizador que indica se backups são realizados para este cluster flexível. O backup usa backups de cluster flexíveis.

false

FlexCluster.status.v20250312.connectionStrings

Coleção de localizadores uniformes de recursos que apontam para o banco de dados MongoDB.

Name
Tipo
Descrição
Obrigatório

standard

string

string de conexão pública que você pode usar para se conectar a esse cluster. Esta string de conexão utiliza o protocolo mongodb://.

false

standardSrv

string

string de conexão pública que pode ser usada para se conectar a esse cluster flexível. Esta string de conexão utiliza o protocolo mongodb+srv://.

false

Voltar

IpaccessListEntry

Próximo

DatabaseUser

Nesta página