O recurso personalizado do AtlasProject configura o projeto no Atlas. Ao criar o recurso personalizado AtlasProject , o Atlas Kubernetes Operator tenta criar um novo projeto no Atlas.
Importante
Os Recursos Personalizados Não Excluem Mais Objetos por Padrão
O Atlas Kubernetes Operator usa arquivos de configuração de recurso personalizado para gerenciar sua configuração do Atlas , mas a partir do Atlas Kubernetes Operator,2.0 os recursos personalizados que você exclui no Kubernetes não são mais (por padrão) excluídos no Atlas. Em vez disso, o Atlas Kubernetes Operator simplesmente para de gerenciar estes recursos no Atlas. Por exemplo, se você excluir um
AtlasProjectRecurso Personalizado no Kubernetes, por padrão, o Atlas Kubernetes Operator não excluirá mais automaticamente o projeto correspondente do Atlas. Essa mudança no comportamento destina-se a ajudar a evitar exclusões acidentais ou inesperadas. Para saber mais, incluindo como reverter este comportamento para o padrão utilizado antes do Atlas Kubernetes 2 0Operator., consulte Novo padrão: proteção de exclusão no Atlas Kubernetes 2 0Operator..Da mesma forma, o Atlas Kubernetes Operator não exclui equipes do Atlas se você as remover de um projeto do Atlas no Kubernetes com o Atlas Kubernetes Operator.
Defina explicitamente os detalhes de configuração desejados para evitar o uso implícito de valores de configuração padrão do Atlas . Em alguns casos, herdar os padrões do Atlas pode resultar em um loop de reconciliação que pode impedir que seu recurso personalizado atinja um estado
READY. Por exemplo, definir explicitamente o comportamento de autoscaling desejado em seu recurso personalizadoAtlasDeployment, conforme mostrado no exemplo incluído, garante que um tamanho de instância estática em seu recurso personalizado não esteja sendo aplicado repetidamente a um sistema do Atlas que tenha o autoscaling ativado.autoScaling: diskGB: enabled: true compute: enabled: true scaleDownEnabled: true minInstanceSize: M30 maxInstanceSize: M40
O Atlas Kubernetes Operator realiza uma das seguintes ações:
Cria um novo projeto na organização que o segredo de conexão configura.
Reutiliza um projeto existente. Neste caso, o Atlas Kubernetes Operator verifica se existe um projeto com
spec.name. Se o projeto existir, o Atlas Kubernetes Operator ignorará a criação. Após a reconciliação, o Atlas Kubernetes Operator atualiza o campostatus.idcom o ID do projeto.
Você pode usar o parâmetro spec.connectionSecretRef.name para definir o segredo de conexão para o recurso personalizado AtlasProject. Este parâmetro substitui o global segredo de conexão padrão.
Por padrão, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o Recurso PersonalizadoAtlasProject . Para armazenar segredos em outro namespace, especifique o spec.connectionSecretRef. parâmetro do namespace .
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 editar a especificação do recurso personalizado do AtlasProject para configurar as seguintes opções:
Uma lista de acesso IP com o spec.projectIpAccessList Parâmetro. Esta lista de acesso IP concede acesso de rede aos clusters Atlas no projeto.
Equipes com o parâmetro spec.teams. Uma equipe permite que você conceda uma função de acesso a um grupo inteiro de usuários do Atlas para um projeto específico.
O período de manutenção com a spec.maintenanceWindow Parâmetro. A janela de manutenção define a hora e o dia em que o Atlas inicia a manutenção semanal nas suas implantações de banco de dados.
Emparelhamento de rede com o spec.networkPeers Parâmetro. O emparelhamento de rede permite que você se conecte com segurança ao seu AWS, Azure, ou Google Cloud VPC.
Criptografia em repouso usando chaves gerenciadas pelo cliente com o spec.encryptionAtRest Parâmetro. A criptografia em descanso usando chaves gerenciadas pelo cliente permite que você adicione uma camada adicional de segurança usando o KMS do seu provedor de nuvem junto com o mecanismo de armazenamento criptografado do MongoDB encrypted storage engine..
pontos de extremidade privados com o spec.privateEndpoints Parâmetro.
X.509 autenticação com o parâmetro spec.x509CertRef.name.
Configurações do projeto com o parâmetro spec.settings, incluindo configurações para habilitar e desabilitar o seguinte:
Collection de estatísticas de banco de dados em métricas de cluster
Configurações de alertas de projeto com o spec.alertConfigurationSyncEnabled e spec.alertConfigurations parâmetros.
Para obter informações sobre como essas configurações interagem, consulte as Considerações.
Se você remover o recurso AtlasProject do seu cluster Kubernetes, o Atlas Kubernetes Operator removerá o projeto do Atlas. Antes, é necessário remover todos os clusters do projeto. Caso contrário, o Atlas rejeita a solicitação de exclusão.
Exemplo
O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject :
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test project connectionSecretRef: name: my-atlas-key projectIpAccessList: - cidrBlock: "203.0.113.0/24" comment: "CIDR block for Application Server B - D"
Exemplo de Prometheus
O exemplo a seguir mostra uma especificação de recurso personalizada AtlasProject que se integra ao Prometheus:
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: TestPrometheusIntegration connectionSecretRef: name: my-atlas-key projectIpAccessList: - cidrBlock: "0.0.0.0/1" comment: "Everyone has access. For test purposes only." - cidrBlock: "128.0.0.0/1" comment: "Everyone has access. For test purposes only." integrations: - type: "PROMETHEUS" enabled: "true" username: "prometheus-user" passwordRef: name: "password-name" namespace: "password-namespace" scheme: "http" serviceDiscovery: "http"
Para saber mais, consulte Integração com serviços de terceiros.
Observação
Atlas Kubernetes Operator oferece um exemplo de dashboard do Grafana que você pode importar para o Grafana.
Exemplo de equipes
O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que fornece ao green-leaf-team a função Organization Owner para esse projeto. Os membros da equipe são definidos no recurso personalizado do AtlasTeam.
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test project teams: - teamRef: name: green-leaf-team roles: - ORGANIZATION_OWNER
Para saber mais, consulte Configurar equipes.
Exemplo de período de manutenção
O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que define a janela de manutenção para as 5h todas as terças-feiras com o adiamento automático desabilitado:
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test project projectIpAccessList: - ipAddress: "192.0.2.15" comment: "IP address for Application Server A" maintenanceWindow: dayOfWeek: 3 hourOfDay: 5 autoDefer: false
Exemplo de configurações do projeto
O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que desabilita a coleta de estatísticas do banco de dados em métricas de cluster, explorador de dados, Performance Advisor de desempenho, Painel de desempenho em tempo real e Consultor de esquema.
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test project projectIpAccessList: - ipAddress: "192.0.2.15" comment: "IP address for Application Server A" settings: isCollectDatabaseSpecificsStatisticsEnabled: false isDataExplorerEnabled: false isExtendedStorageSizesEnabled: false isPerformanceAdvisorEnabled: false isRealtimePerformancePanelEnabled: false isSchemaAdvisorEnabled: false
Exemplo de configuração de alerta
O exemplo a seguir mostra uma especificação de recurso personalizado AtlasProject que configura um alerta Atlas Triggers se a oplog window atingir menos de uma hora:
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test Atlas Operator Project connectionSecretRef: name: my-atlas-key alertConfigurations: - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", enabled: true, notifications: - delayMin: 0 emailEnabled: true intervalMin: 60 roles: [ "GROUP_OWNER" ] smsEnabled: false typeName: "GROUP" threshold: operator: "LESS_THAN", threshold: "1", units: "HOURS" alertConfigurationSyncEnabled: true withDefaultAlertsSettings: false
Exemplo de configuração de alerta de terceiros
O exemplo abaixo mostra uma especificação de recurso personalizada AtlasProject que configura um alerta que envia notificações pelo Slack:
apiVersion: atlas.mongodb.com/v1 kind: AtlasProject metadata: name: my-project spec: name: Test Atlas Operator Project connectionSecretRef: name: my-atlas-key alertConfigurations: - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT" enabled: true notifications: - delayMin: 0 emailEnabled: true intervalMin: 60 roles: [ "GROUP_OWNER" ] smsEnabled: false - typeName: "SLACK" apiTokenRef: name: key-name namespace: key-namespace threshold: operator: "LESS_THAN" threshold: "1" units: "HOURS" alertConfigurationSyncEnabled: true withDefaultAlertsSettings: false
Parâmetros
Projeto Atlas
AtlasProject é o esquema para a API de atlasprojects
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | atlas.mongodb.com/v1 | true |
| string |
| true |
| objeto | Consulte a documentação do Kubernetes | true |
| objeto |
| false |
| objeto |
| false |
AtlasProject.spec
AtlasProjectSpec define o estado de destino do projeto no Atlas
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | O Nome é o
| true |
| booleano |
| false |
| [] objeto |
| false |
| objeto | Auditoria representa | false |
| objeto |
| false |
| [] objeto |
| false |
| [] objeto |
| false |
| objeto |
| false |
| [] objeto |
| false |
| objeto |
| false |
| [] objeto | Integrações é uma lista de | false |
| objeto |
| false |
| [] objeto |
| false |
| [] objeto |
| false |
| [] objeto |
| false |
| enum |
| false |
| objeto | Configurações permite definir as Configurações do projeto. | false |
| [] objeto | As equipes permitem que você conceda funções de acesso ao projeto a vários usuários. | false |
| booleano | Sinalizador que indica se o Atlas Kubernetes Operator cria um projeto com as configurações de alerta padrão. Se você utilizar esta configuração, você também deverá definir spec.''alertConfigurationSyncEnabled'' como true para o Atlas Kubernetes Operator modificar as configurações de alerta do projeto. Se você definir esse parâmetro como falso ao criar um projeto, o Atlas não adicionará as configurações de alerta padrão ao seu projeto. Esta configuração não tem efeito sobre projetos existentes. Padrão: true | false |
| objeto | X509CertRef é uma referência ao Kubernetes Secret que contém o certificado | false |
AtlasProject.spec.alertConfigurations
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Se omitido, a configuração será desabilitada. | false |
| string | O tipo de evento que trigger um alerta. | false |
| [] objeto | Você pode filtrar usando a array | false |
| objeto |
| false |
| [] objeto | As notificações estão sendo enviadas quando uma condição de alerta é detectada. | false |
| enum |
| false |
| objeto | O limite faz com que um alerta seja acionado. | false |
AtlasProject.spec.alertConfigurations.matchers
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do campo no objeto de destino a ser correspondido. | false |
| string | O | false |
| string | Valor para testar com o operador especificado. | false |
AtlasProject.spec.alertConfigurations.metricThreshold
MetricThreshold faz com que um alerta seja acionado.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Valor limite fora do qual um alerta será acionado. | true |
| string | Nome da métrica a ser verificada. | false |
| string | Isso deve ser definido como | false |
| string | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. | false |
| string | O | false |
AtlasProject.spec.alertConfigurations.notificações
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| objeto | Segredo contendo um token Slack | false |
| string | Nome do canal do Slack. Preenchido para o tipo de notificações do | false |
| objeto | Segredo contendo uma chave Datadog | false |
| string | Região que indica qual | false |
| inteiro | Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação. | false |
| string | Endereço de e-mail para o qual as notificações de alerta são enviadas. Preenchido para o tipo de notificações do | false |
| booleano | Sinalizador que indica se notificações por e-mail devem ser enviadas. Preenchido para tipos de notificações do | false |
| string | Nome do fluxo Flowdock em letras minúsculas. | false |
| objeto | O token Flowdock | false |
| inteiro | Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos. | false |
| string | Número de celular para o qual notificações de alerta são enviadas. Preenchido para o tipo de notificações do | false |
| objeto |
| false |
| string | Região que indica qual | false |
| string | Nome da organização Flowdock em letras minúsculas. Este é o nome que aparece após http://www.flowdock.com/app/ na string | false |
| []string | Os seguintes | false |
| objeto |
| false |
| booleano | Sinalizador que indica se as notificações de mensagem de texto devem ser enviadas. Preenchido para tipos de notificações do | false |
| string | Identificador único de uma equipe. | false |
| string | Etiqueta para a equipe que recebe esta notificação. | false |
| string | Tipo de notificação de alerta . | false |
| string | Nome do Atlas user para o qual enviar notificações. Somente um usuário no projeto que possui a configuração de alerta é permitido aqui. Preenchido para o tipo de notificações do | false |
| objeto | Segredo contendo uma chave | false |
AtlasProject.spec.alertConfigurations.notificações.apiTokenRef
Segredo contendo um token de API do Slack ou token de Bot. Preenchido para o tipo de notificações SLACK. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.notifications.datadogAPIKeyRef
Segredo contendo uma chave API Datadog. Encontrado no painel do Datadog. Preenchido para o tipo de notificações DATADOG.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.notifications.flowdockApiTokenRef
O token da API pessoal do Flowdock. Preenchido para o tipo de notificações Flowdock. Se o token posteriormente se tornar inválido, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.notificações.opsGenieApiKeyRef
Chave API OpsGenie. Preenchido para o tipo de notificações OPS_GENIE. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá o token.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.notificações.serviceKeyRef
Chave de serviço PagerDuty. Preenchido para o tipo de notificações PAGER_DUTY. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.notificações.victorOpsSecretRef
Segredo contendo uma chave de API VictorOps e uma chave de roteamento. Preenchido para o tipo de notificações VICTOR_OPS. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail ao proprietário do projeto e eventualmente removerá a chave.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.alertConfigurations.threshold
O limite faz com que um alerta seja acionado.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. Aceita os seguintes valores: | false |
| string | Valor limite fora do qual um alerta será acionado. | false |
| string | O | false |
AtlasProject.spec.auditoria
Auditar representa as janelas de manutenção do MongoDB Windows.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Indica se o sistema de auditoria captura tentativas de autenticação bem-sucedidas para filtros de auditar usando o evento de auditoria "atype" : " | false |
| string |
| false |
| booleano | Indica se o projeto associado ao { | false |
AtlasProject.spec.backupCompliancePolicyRef
BackupCompliancePolicyRef é uma referência ao recurso personalizado de compliance de backup.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.cloudProviderAccessRoles
CloudProviderAccessRole define uma integração com um provedor de nuvem DEPrecated: este tipo é preterido em favor do CloudProviderIntegration
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string |
| true |
| string |
| false |
AtlasProject.spec.cloudProviderIntegrations
CloudProviderIntegration define uma integração com um provedor de nuvem
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string |
| true |
| string |
| false |
AtlasProject.spec.connectionSecretRef
ConnectionSecret é o nome do secret do Kubernetes que contém as informações sobre a forma de se conectar ao Atlas (ID da organização, chaves de API). A configuração padrão da conexão do operador será usada se não for fornecida.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.customRoles
CustomRole permite criar e alterar um função personalizada em seu cluster. Utilize funções personalizadas para especificar conjuntos personalizados de ações que as funções integradas do Atlas não conseguem descrever. Obsoleto: Migrar para o recurso personalizado AtlasCustomRoles de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ek8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Etiqueta legível por humanos que identifica a função. Este | true |
| [] objeto | Lista do privilégio individual | false |
| [] objeto | Lista das funções incorporadas que esta função personalizada herda. | false |
AtlasProject.spec.customRoles.ações
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Etiqueta legível por humanos que identifica a ação do privilégio. | true |
| [] objeto | Lista de | true |
AtlasProject.spec.customRoles.ações.recursos
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Sinalizador que indica se a ação deve ser concedida no recurso | false |
| string | Etiqueta legível por humanos que identifica o | false |
| string | Etiqueta legível por humanos que identifica o | false |
AtlasProject.spec.customRoles.inheritedRoles
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Etiqueta legível por humanos que identifica o | true |
| string | Etiqueta legível por humanos que identifica a função herdada. | true |
AtlasProject.spec.encryptionAtRest
EncryptionAtRest permite definir a criptografia para provedores da AWS, do Azure e do GCP.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| objeto |
| false |
| objeto |
| false |
| objeto |
| false |
AtlasProject.spec.encryptionAtRest.awsKms
O AwsKms especifica os detalhes de configuração do AWS KMS e se a criptografia em descanso está habilitada para um projeto do Atlas.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Especifica se a criptografia em descanso é | false |
| string | O | false |
| objeto | Uma referência como Secret contendo os campos | false |
| booleano | Especifica se a chave de criptografia definida para o provedor é | false |
AtlasProject.spec.encryptionAtRest.awsKms.secretRef
Uma referência como Secret contendo os campos AccessKeyID, SecretAccessKey, CustomerMasterKeyID e RoleID
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.encryptionAtRest.azureKeyVault
AzureKeyVault especifica os detalhes de configuração do Azure Key Vault e se a criptografia em descanso está habilitada para um projeto do Atlas.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | O ambiente Azure onde residem as credenciais da conta Azure. Os valores válidos são os seguintes: | false |
| string | O cliente | false |
| booleano | Especifica se a criptografia em descanso é | false |
| string | O nome do grupo de recursos do Azure que contém um Azure Key Vault. | false |
| objeto | Uma referência a como Secret contendo os campos | false |
| string | O identificador exclusivo para um locatário do Azure | false |
AtlasProject.spec.encryptionAtRest.azureKeyVault.secretRef
Uma referência como Segredo contendo os campos SubscriptionID, KeyVaultName, KeyIdentifier, Segredo
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.encryptionAtRest.googleCloudKms
O GoogleCloudKms especifica os detalhes de configuração do GCP KMS e se a criptografia em descanso está ativada para um projeto do Atlas.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Especifica se a criptografia em descanso é | false |
| objeto | Uma referência a como Secret contendo os campos | false |
AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef
Uma referência a como Secret contendo os campos ServiceAccountKey, KeyVersionResourceID
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations
Integração para o projeto entre Atlas e um serviço de terceiros. Obsoleto: Migre para o recurso personalizado AtlasThirdPartyIntegration de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Sequência exclusiva de 40dígitos hexadecimais que identifica sua conta New Relic. | false |
| objeto | Referência a um secret do Kubernetes contendo sua chave | false |
| objeto | Referência a um secret do Kubernetes contendo a chave que permite ao Atlas acessar sua conta do Slack. | false |
| string | Nome do canal do Slack para o qual o Atlas envia notificações de alerta. | false |
| booleano | Sinalizador que indica se alguém ativou a integração Prometeus. | false |
| string |
| false |
| objeto | Referência a um Kubernetes Secret contendo sua string única de 40dígitos hexadecimais que identifica sua licença do New Relic. | false |
| string | Endereço web de ponto de extremidade do webhook do Microsoft Teams para o qual o Atlas envia notificações. | false |
| string | false | |
| string |
| false |
| objeto | Referência a um secret do Kubernetes contendo a senha para permitir que o Atlas acesse sua conta Prometheus. | false |
| objeto | Referência a um secret do Kubernetes contendo a chave de query associada à sua conta New Relic. | false |
| string | Código de região que indica qual | false |
| objeto | Referência a um secret do Kubernetes contendo a chave de roteamento associada à sua conta Splunk On-Call. Usado para Victor Ops. | false |
| string | false | |
| objeto | Referência a um secret do Kubernetes que contém o segredo do seu webhook. | false |
| string | Método desejado para descobrir o serviço Prometheus. | false |
| objeto | Referência a um Kubernetes Secret contendo a chave de serviço associada à sua conta | false |
| string | Etiqueta legível por humanos que identifica sua equipe do Slack . | false |
| enum | Integração de terceiros | false |
| string | Endereço web do ponto de extremidade para o qual o Atlas envia notificações. Usado para webhooks. | false |
| string | Etiqueta legível por humanos que identifica o webhook de entrada do Prometheus. | false |
| objeto | Referência a um secret do Kubernetes contendo a chave de inserção associada à sua conta New Relic. | false |
AtlasProject.spec.integrations.apiKeyRef
Referência a um secret do Kubernetes contendo sua chave de API para Datadog, OpsGenie ou Victor Ops.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.apiTokenRef
Referência a um secret do Kubernetes contendo a chave que permite ao Atlas acessar sua conta do Slack.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.licenseKeyRef
Referência a um Kubernetes Secret contendo sua string única de 40dígitos hexadecimais que identifica sua licença do New Relic.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.passwordRef
Referência a um secret do Kubernetes contendo a senha para permitir que o Atlas acesse sua conta Prometheus.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.readTokenRef
Referência a um secret do Kubernetes contendo a chave de query associada à sua conta New Relic.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.routingKeyRef
Referência a um secret do Kubernetes contendo a chave de roteamento associada à sua conta Splunk On-Call. Usado para Victor Ops.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.secretRef
Referência a um secret do Kubernetes que contém o segredo do seu webhook.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.serviceKeyRef
Referência a um secret do Kubernetes contendo a chave de serviço associada à sua conta PagerDuty.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.integrations.writeTokenRef
Referência a um secret do Kubernetes contendo a chave de inserção associada à sua conta New Relic.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.maintenanceWindow
O maintenanceWindow permite especificar um horário preferencial na semana para executar operações de manutenção. Veja mais informações em https://www.mongodb.com/pt-br/docs/atlas/reference/api/maintenance-windows/
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Sinalizador que indica se qualquer manutenção de projeto agendada deve ser adiada automaticamente por uma semana. | false |
| inteiro | Dia da semana em que você gostaria que a período de manutenção começasse como um número inteiro baseado em 1. 1Domingo,2 3 4 5 6 7segunda-feira, ter- Mínimo: 1 Máximo: 7 | false |
| booleano | Sinalizador que indica se a próxima manutenção de projeto agendada deve ser adiada por uma semana. Não é possível especificar se | false |
| inteiro | Hora do dia em que você gostaria que a período de manutenção começasse. Este parâmetro utiliza o relógio de 24horas, em que meia-noite é 0 e meio-dia é 12. Mínimo: 0 Máximo: 23 | false |
| booleano | Sinalizador que indica se a manutenção do projeto foi direcionada para iniciar imediatamente. Não é possível especificar se adiar é verdadeiro | false |
AtlasProject.spec.networkPeers
NetworkPeer configurado para o Projeto atual. Obsoleto: migrar para os recursos personalizados AtlasNetworkPeering e AtlasNetworkContainer de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string |
| false |
| string | Atlas | false |
| string |
| false |
| string |
| false |
| string |
| false |
| string |
| false |
| string |
| false |
| string | Usuário | false |
| string |
| false |
| string |
| false |
| string |
| false |
| string | Usuário | false |
| string | VNetName é o nome da sua VNet do Azure. É aplicável apenas ao Azure. | false |
| string |
| false |
AtlasProject.spec.privateEndpoints
Ponto de extremidade privado é uma lista de pontos de extremidade privados configurados para o projeto atual. Obsoleto: migrar para o recurso personalizado AtlasPrivateEndpoint de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| enum | Nuvem | true |
| string | Provedor de nuvem | true |
| string | Identificador único do grupo de pontos de extremidade. O grupo de pontos de extremidade engloba todos os pontos de extremidade que você criou no Google Cloud. | false |
| [] objeto | Coleção de | false |
| string | Identificador exclusivo do projeto do Google Cloud no qual você criou seus pontos de extremidade. | false |
| string | Identificador exclusivo do ponto de extremidade privado que você criou em sua | false |
| string | Endereço | false |
AtlasProject.spec.privateEndpoints.pontos de extremidade
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Regra de encaminhamento que corresponde ao ponto de extremidade que você criou no Google Cloud. | false |
| string | Endereço | false |
AtlasProject.spec.projectIpAccessList
IPAccessList permite o uso da lista de acesso IP para um projeto. Veja mais informações em https://mongodb.com/pt-br/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migre para o recurso personalizado AtlasIPAccessList de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Identificador exclusivo do grupo de segurança | false |
| string | Faixa de endereços | false |
| string | Comentário associado a esta entrada da lista de acesso. | false |
| string | Registro de data/hora em | false |
| string | Entrada usando um endereço | false |
AtlasProject.spec.settings
Configurações permite definir as Configurações do projeto.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| booleano | Sinalizador que indica se é necessário coletar métricas específicas do banco de dados para o projeto especificado. | false |
| booleano | Sinalizador que indica se o Data Explorer deve ser ativado para o projeto especificado. | false |
| booleano | Sinalizador que indica se os tamanhos de armazenamento estendidos devem ser habilitados para o projeto especificado. | false |
| booleano | Sinalizador que indica se o Performance Advisor e o Profiler devem ser habilitados para o projeto especificado. | false |
| booleano | Sinalizador que indica se deseja ativar o Real-Time Performance Panel para o projeto especificado. | false |
| booleano | Sinalizador que indica se o Schema Advisor deve ser ativado para o projeto especificado. | false |
AtlasProject.spec.equipes
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| []enum | Funções que os usuários da equipe têm dentro do projeto. enumeração: | true |
| objeto | Referência ao recurso personalizado | true |
AtlasProject.spec.teams.teamRef
Referência ao recurso personalizado do AtlasTeam que será atribuído ao projeto.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.spec.x509CertRef
X509CertRef é uma referência ao Kubernetes Secret que contém o certificado CA codificado por PEM. O Atlas Kubernetes Operator observa segredos apenas com o rótulo atlas.mongodb.com/type=credentials para evitar assistir a segredos desnecessários.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |
AtlasProject.status
AtlasProjectStatus define o estado observado do AtlasProject
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| [] objeto | Condições é a lista de status que mostra o estado atual do Recurso Personalizado do Atlas | true |
| [] objeto |
| false |
| []string |
| false |
| [] objeto |
| false |
| [] objeto |
| false |
| [] objeto | A lista de | false |
| string | O | false |
| [] objeto | A lista de emparelhamento de rede configurados para o projeto atual | false |
| inteiro |
| false |
| [] objeto | A lista de pontos de extremidade privados configurados para o projeto atual | false |
| objeto | Prometheus contém o status da integração de Prometheus, incluindo o | false |
| [] objeto | As equipes contêm uma lista de status de tarefa do | false |
AtlasProject.status. conditions
A condição descreve o estado de um recurso personalizado do Atlas em um determinado ponto.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Status da condição; um de verdadeiro, falso, desconhecido. | true |
| string | Tipo de condição do Atlas recurso. | true |
| string | Última vez que a condição fez a transição de um status para outro. Representado no formato | false |
| string | Um | false |
| string | O | false |
AtlasProject.status.alertConfigurations
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | A data até a qual o alerta foi reconhecido. Não estará presente se o alerta nunca tiver sido reconhecido. | false |
| string | O comentário deixado pelo usuário que reconheceu o alerta. Não estará presente se o alerta nunca tiver sido reconhecido. | false |
| string | O nome de usuário que reconheceu o alerta. Não estará presente se o alerta nunca tiver sido reconhecido. | false |
| string |
| false |
| string | O | false |
| string | O nome do cluster ao qual esse alerta se aplica. Presente apenas para alertas do tipo | false |
| string | Registro de data/hora no formato de data e hora | false |
| objeto |
| false |
| booleano | Se omitido, a configuração será desabilitada. | false |
| string |
| false |
| string | O tipo de evento que trigger um alerta. | false |
| string | Identificador único do projeto que possui esta configuração de alerta . | false |
| string |
| false |
| string | O nome do host e a porta de cada host ao qual o alerta se aplica. Presente apenas para alertas do tipo | false |
| string | Identificador único. | false |
| string | Quando a última notificação foi enviada para este alerta. Presente somente se notificações tiverem sido enviadas. | false |
| [] objeto | Você pode filtrar usando a array | false |
| string | O nome da medida cujo valor ultrapassou o limite. Somente presente se | false |
| objeto |
| false |
| [] objeto | As notificações estão sendo enviadas quando uma condição de alerta é detectada. | false |
| string | Nome do conjunto de réplicas. Presente somente para alertas do tipo | false |
| string | Quando o alerta foi fechado. Presente apenas se o status for | false |
| string | Gravidade do alerta. | false |
| string | Para alertas do tipo | false |
| string | O estado atual do alerta. Os valores possíveis são: | false |
| objeto | O limite faz com que um alerta seja acionado. | false |
| string | Registro de data/hora no formato de data e hora | false |
AtlasProject.status.alertConfigurations.currentValue
CurrentValue representa o valor atual da métrica que acionou o alerta. Presente apenas para alertas do tipo HOST_METRIC.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | O valor da métrica. | false |
| string | O | false |
AtlasProject.status.alertConfigurations.matchers
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do campo no objeto de destino a ser correspondido. | false |
| string | O | false |
| string | Valor para testar com o operador especificado. | false |
AtlasProject.status.alertConfigurations.metricThreshold
MetricThreshold faz com que um alerta seja acionado.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Valor limite fora do qual um alerta será acionado. | true |
| string | Nome da métrica a ser verificada. | false |
| string | Isso deve ser definido como | false |
| string | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. | false |
| string | O | false |
AtlasProject.status.alertConfigurations.notificações
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Token Slack | false |
| string | Nome do canal do Slack. Preenchido para o tipo de notificações do | false |
| string | Chave Datadog | false |
| string | Região que indica qual | false |
| inteiro | Número de minutos para aguardar após uma condição de alerta ser detectada antes de enviar a primeira notificação. | false |
| string | Endereço de e-mail para o qual as notificações de alerta são enviadas. Preenchido para o tipo de notificações do | false |
| booleano | Sinalizador que indica se notificações por e-mail devem ser enviadas. Preenchido para tipos de notificações do | false |
| string | Nome do fluxo do Flowdock em letras minúsculas. | false |
| string | O token Flowdock | false |
| inteiro | Número de minutos para aguardar entre notificações sucessivas para alertas não confirmados que não foram resolvidos. | false |
| string | Número de celular para o qual notificações de alerta são enviadas. Preenchido para o tipo de notificações do | false |
| string | Chave Opsgenie | false |
| string | Região que indica qual | false |
| string | Nome da organização Flowdock em letras minúsculas. Este é o nome que aparece após http://www.flowdock.com/app/ na string | false |
| []string | Os seguintes | false |
| string |
| false |
| booleano | Sinalizador que indica se as notificações de mensagem de texto devem ser enviadas. Preenchido para tipos de notificações do | false |
| string | Identificador único de uma equipe. | false |
| string | Etiqueta para a equipe que recebe esta notificação. | false |
| string | Tipo de notificação de alerta . | false |
| string | Nome do Atlas user para o qual enviar notificações. Somente um usuário no projeto que possui a configuração de alerta é permitido aqui. Preenchido para o tipo de notificações do | false |
| string |
| false |
| string |
| false |
AtlasProject.status.alertConfigurations.threshold
O limite faz com que um alerta seja acionado.
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Operador a ser aplicado ao verificar o valor da métrica atual em relação ao valor limite. aceita os seguintes valores: | false |
| string | Valor limite fora do qual um alerta será acionado. | false |
| string | O | false |
AtlasProject.status.cloudProviderIntegrations
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string |
| true |
| string | Rótulo legível por humanos que identifica o fornecedor de nuvem da função. | true |
| string | Amazon Recurso que identifica a conta de usuário do Amazon Web Services que o | false |
| string | Data e hora em que alguém autorizou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora | false |
| string | Data e hora em que alguém criou esta função para o provedor de serviços de nuvem especificado. Este parâmetro expressa seu valor no formato de registro de data/hora | false |
| string | Mensagem de erro do aplicativo retornada. | false |
| [] objeto | Lista que contém recursos do aplicativo associados a essa função do Amazon Web Services Identity and Access Management. | false |
| string | Nome do recurso da Amazon que identifica a função de gerenciamento de acesso e identidade do Amazon Web Services que o | false |
| string | String única de 24 dígitos hexadecimais que identifica a role. | false |
| string | Provisionamento | false |
AtlasProject.status.cloudProviderIntegrations.featureUsages
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Identificar características do data lake vinculado a essa função do Amazon Web Services Gerenciamento de Identidade e Acesso. | false |
| string | Etiqueta legível por humanos que descreve um recurso do | false |
AtlasProject.status.customRoles
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Função | true |
| string | O | true |
| string | A mensagem quando a função personalizada está no status | false |
AtlasProject.status.expiredIpAccessList
IPAccessList permite o uso da lista de acesso IP para um projeto. Veja mais informações em https://mongodb.com/pt-br/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migre para o recurso personalizado AtlasIPAccessList de acordo com o guia de migração em https://www.mongodb.com/pt-br/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Identificador exclusivo do grupo de segurança | false |
| string | Faixa de endereços | false |
| string | Comentário associado a esta entrada da lista de acesso. | false |
| string | Registro de data/hora em | false |
| string | Entrada usando um endereço | false |
AtlasProject.status.networkPeers
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Identificador único para | true |
| string | Provedor de nuvem para o qual você deseja recuperar um emparelhamento de rede. | true |
| string | Região para a qual você deseja criar o emparelhamento. Não é necessário para | true |
| string |
| false |
| string | Nome da rede Atlas. Aplicável somente para | false |
| string | Identificador único da conexão de peering de rede. Aplicável somente para | false |
| string |
| false |
| string | Estado de erro do peer de rede. Aplicável somente para | false |
| string | Estado de erro do peer de rede. Aplicável apenas para Azure. | false |
| string | Estado de erro do peer de rede. Aplicável somente para | false |
| string |
| false |
| string | Status do emparelhamento de rede. Aplicável apenas para | false |
| string | Status do emparelhamento de rede. Aplicável somente para | false |
| string |
| false |
AtlasProject.status.privateEndpoints
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nuvem | true |
| string | Provedor de nuvem | true |
| [] objeto | Coleção de | false |
| string | Identificador exclusivo para | false |
| string | Identificador exclusivo do | false |
| []string | Strings únicas de caracteres alfanuméricos e especiais que identificam os anexos de serviço associados ao serviço de ponto de extremidade do Private Service Connect | false |
| string | Nome do | false |
| string | Identificador exclusivo do Azure Private Link (para | false |
AtlasProject.status.privateEndpoints.pontos de extremidade
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Rótulo legível por humanos que identifica a regra de encaminhamento do consumidor do Google Cloud que você criou. | true |
| string | Um endereço Private Internet Protocol versão 4 (IPv4) para o qual esta regra de encaminhamento do consumidor do Google Cloud se resolve. | true |
| string | Estado do grupo de pontos de extremidade do Atlas | true |
AtlasProject.status.prometheus
O Prometheus contém o status da integração do Prometheus, incluindo o prometheusDiscoveryURL
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string |
| false |
| string | Protocolo | false |
AtlasProject.status.equipes
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| objeto |
| true |
| string | false |
AtlasProject.status.teams.teamRef
ResourceRefNamespaced é uma referência a um Recurso do Kubernetes que permite configurar o namespace
Name | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| string | Nome do Recurso Kubernetes | true |
| string | Namespace do Recurso Kubernetes | false |