`AtlasProject` Recurso personalizado

Nesta página

Exemplo

Exemplo de Prometheus
Exemplo de equipes
Exemplo de período de manutenção
Exemplo de configurações do projeto
Exemplo de configuração de alerta
Exemplo de configuração de alerta de terceiros
Parâmetros

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 AtlasProject Recurso 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 Operator 2.,0 consulte Novo Padrão: Proteção Contra Exclusão no Atlas Kubernetes 2 Operator.0.
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 personalizado AtlasDeployment, 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 campo status.id com o ID do projeto.

Você pode utilizar o parâmetro para definir spec.connectionSecretRef.name o segredo de conexão para o AtlasProject recurso personalizado . 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 como o AtlasProject Recurso Personalizado. Para armazenar segredos em outro namespace, especifique o parâmetro spec.connectionSecretRef.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 parâmetro spec.projectIpAccessList . 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 role de acesso a um grupo inteiro de usuários do Atlas para um projeto específico.
A janela de manutenção com o parâmetro spec.maintenanceWindow . A janela de manutenção define a hora e o dia em que o Atlas inicia a manutenção semanal em seus sistemas de banco de dados.
Emparelhamento de rede com o parâmetro spec.networkPeers . O emparelhamento de rede permite que você se conecte com segurança à Amazon Web Services, Azure ou GCP VPC.
Criptografia em repouso usando chaves gerenciadas pelo cliente com o parâmetro spec.encryptionAtRest . A criptografia em repouso usando chaves gerenciadas pelo cliente permite que você adicione uma camada adicional de segurança usando o do seu fornecedor de nuvem KMS junto com o MongoDB criptografado do storage engine.
Endpoints privados com o parâmetro spec.privateEndpoints .
Autenticação X.509 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
- Explorador de dados
- Assistente de desempenho
- Painel de desempenho em tempo real
- Consultor de esquemas
- Configurações de alertas do projeto com os parâmetros spec.alertConfigurationSyncEnabled e spec.alertConfigurations .
  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

O Atlas Kubernetes Operator oferece uma amostra do dashboard do Grafana que você pode importar para 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

Esta seção descreve os parâmetros do recurso personalizado AtlasProject :

spec.name

Tipo: string

Obrigatório

Nome do projeto criado ou atualizado no Atlas. O comprimento do nome não deve exceder 64 caracteres. O nome pode conter apenas letras, números, espaços, traços e sublinhados.

spec.alertConfigurations

Tipo: array de objetos

Opcional

Lista que contém configurações de alerta para este projeto.

Se você utilizar esta configuração, você também deverá configurar o spec.alertConfigurationSyncEnabled para true para o Atlas Kubernetes Operator modificar as configurações de alerta do projeto.

Se você omitir ou deixar esta configuração vazia, o Atlas Kubernetes Operator não alterará as configurações de alerta do projeto. Ao criar um projeto, o Atlas aplicará as configurações de alerta de projeto padrão.

spec.alertConfigurations.eventTypeName

Tipo: string

Obrigatório

evento que Atlas Triggers um alerta descrito por essa configuração de alerta.

Para saber mais sobre os valores que o Atlas Kubernetes Operator aceita, consulte o esquema do corpo da solicitação para o endpoint Create One Alert Configuration in One Project na documentação da API de Administração do MongoDB Atlas.

spec.alertConfigurations.enabled

Tipo: booleano

Opcional

Padrão: false

Sinalizador que indica se esta configuração de alerta está habilitada. Se omitido, o padrão é false.

spec.alertConfigurations.matchers

Tipo: array de objetos

Condicional

Lista de regras que determinam se o Atlas verifica um objeto para a configuração de alerta. Você pode filtrar usando a array de correspondentes se spec.alertConfigurations.eventTypeName especificar um evento para um host, conjunto de réplicas ou cluster fragmentado.

spec.alertConfigurations.matchers.fieldName

Tipo: string

Condicional

Etiqueta legível para humanos que identifica o parâmetro no objeto de destino que o Atlas verifica. O parâmetro deve corresponder a todas as regras para que o Atlas verifique as configurações de alerta.

O Atlas Kubernetes Operator aceita os seguintes valores:

CLUSTER_NAME
HOSTNAME
HOSTNAME_AND_PORT
PORT
REPLICA_SET_NAME
SHARD_NAME
TYPE_NAME

O Atlas Kubernetes Operator exige esta configuração se você incluir um objeto na array spec.alertConfigurations.matchers .

spec.alertConfigurations.matchers.operator

Tipo: string

Condicional

Operador de comparação a ser aplicado ao verificar o valor da métrica atual em relação a spec.alertConfigurations.matchers.value.

O Atlas Kubernetes Operator aceita os seguintes valores:

EQUALS
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
NOT_CONTAINS
REGEX

O Atlas Kubernetes Operator exige esta configuração se você incluir um objeto na array spec.alertConfigurations.matchers .

spec.alertConfigurations.matchers.value

Tipo: string

Condicional

O valor a ser igual ou superior ao spec.alertConfigurations.matchers.operator especificado.

O Atlas Kubernetes Operator exige esta configuração se você incluir um objeto na array spec.alertConfigurations.matchers .

spec.alertConfigurations.metricThreshold

Tipo: objeto

Condicional

Limite para a métrica que, quando excedido, Atlas Triggers um alerta.

O Atlas Kubernetes Operator requer essa configuração quando spec.alertConfigurations.eventTypeName está OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.metricThreshold.metricName

Tipo: string

Condicional

Etiqueta legível por humanos que identifica a métrica em relação à qual o Atlas verifica o spec.alertConfigurations.metricThreshold.threshold configurado .

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.metricThreshold .

spec.alertConfigurations.metricThreshold.mode

Tipo: string

Opcional

Padrão: AVERAGE

O Atlas calcula o valor da métrica atual como uma média.

O Atlas Kubernetes Operator aceita apenas um valor de AVERAGE.

spec.alertConfigurations.metricThreshold.operator

Tipo: string

Condicional

Operador de comparação a ser aplicado ao verificar o valor da métrica atual.

O Atlas Kubernetes Operator aceita os seguintes valores:

GREATER_THAN
LESS_THAN

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.metricThreshold .

spec.alertConfigurations.metricThreshold.threshold

Tipo: número inteiro

Condicional

Valor da métrica que, quando excedido, Atlas Triggers um alerta.

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.metricThreshold .

spec.alertConfigurations.metricThreshold.units

Tipo: string

Condicional

Elemento usado para Express a quantidade. Esse valor pode ser um elemento de tempo, capacidade de armazenamento e assim por diante

O Atlas Kubernetes Operator aceita os seguintes valores:

BITS
BYTES
DAYS
GIGABITS
GIGABYTES
HOURS
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
MILLISECONDS
MINUTES
PETABYTES
RAW
SECONDS
TERABYTES

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.metricThreshold .

spec.alertConfigurations.notifications

Tipo: array

Condicional

Lista que descreve as notificações que o Atlas envia para alertas que esta configuração de alerta descreve.

spec.alertConfigurations.notifications.apiTokenRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com seu token de API para Slack.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

Se quiser notificações pelo Slack, especifique essa configuração.

spec.alertConfigurations.notifications.apiTokenRef.namespace

Tipo: string

Condicional

namespace que contém seu token de API para o Slack. Se quiser notificações pelo Slack, especifique essa configuração.

spec.alertConfigurations.notifications.channelName

Tipo: string

Condicional

Etiqueta legível por humanos que identifica o canal do Slack para o qual o Atlas envia notificações de alerta.

O Atlas Kubernetes Operator exige esta configuração quando você configura spec.alertConfigurations.notifications.typeName para SLACK.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave API para Datadog. Se você quiser notificações por meio do Datadog, deve especificar essa configuração'.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.datadogApiKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de API para Datadog. Se quiser notificações pelo Datadog, especifique essa configuração.

spec.alertConfigurations.notifications.datadogRegion

Tipo: string

Opcional

Padrão: US

Região do Datadog que indica qual Localizador de recursos uniforme (URL) da API usar.

O Atlas Kubernetes Operator aceita os seguintes valores:

US
EU

spec.alertConfigurations.notifications.delayMins

Tipo: número inteiro

Opcional

Padrão: 0

Número de minutos que o Atlas aguarda após detectar uma condição de alerta antes de enviar a primeira notificação.

spec.alertConfigurations.notifications.emailAddress

Tipo: string

Condicional

Endereço de e-mail para o qual o Atlas envia notificações de alerta.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para EMAIL.

O Atlas Kubernetes Operator não exige esta configuração para enviar notificações por e-mail quando você define o spec.alertConfigurations.notifications.typeName para um dos seguintes valores:

GROUP
ORG
TEAM
USERS

Para enviar e-mails para um Atlas user ou grupo de usuários, configure o parâmetro spec.alertConfigurations.notifications.emailEnabled .

spec.alertConfigurations.notifications.emailEnabled

Tipo: booleano

Condicional

Sinalizador que indica se o Atlas envia notificações por e-mail.

O Atlas Kubernetes Operator exige esta configuração quando você configura o spec.alertConfigurations.notifications.typeName para um dos seguintes valores:

GROUP
ORG
TEAM

spec.alertConfigurations.notifications.intervalMin

Tipo: número inteiro

Opcional

Número de minutos para esperar entre notificações sucessivas. O Atlas envia notificações até que alguém reconheça o alerta não confirmado. O Atlas Kubernetes Operator aceita valores maiores ou iguais a 5.

As notificações PagerDuty, VictorOps e OpsGenie não usam esse campo. Configure e managed o intervalo de notificação dentro de cada um desses serviços.

spec.alertConfigurations.notifications.microsoftTeamsWebhookUrl

Tipo: string

Condicional

Localizador de recursos uniforme do webhook do Microsoft equipe (URL) que o Atlas precisa para enviar esta notificação via Microsoft equipe. Se o URL posteriormente se tornar inválido, o Atlas enviará um e-mail aos proprietários do projeto. Se a chave permanecer inválida, o Atlas a removerá.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para MICROSOFT_TEAMS.

spec.alertConfigurations.notifications.mobileNumber

Tipo: string

Condicional

Número de celular para o qual o Atlas envia notificações de alerta.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para SMS.

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave API para Opsgenie. Se você quiser notificações por meio do Opsgenie, especifique essa configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.opsGenieApiKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de API para Opsgenie. Se quiser notificações por meio do Opsgenie, especifique essa configuração.

spec.alertConfigurations.notifications.opsGenieRegion

Tipo: string

Opcional

Padrão: US

Região do Opsgenie que indica qual Localizador de recursos uniforme (URL) da API usar.

O Atlas Kubernetes Operator aceita os seguintes valores:

US
EU

O Atlas Kubernetes Operator aplica essa configuração se você definir spec.alertConfigurations.notifications.typeName como OPS_GENIE.

spec.alertConfigurations.notifications.roles

Tipo: array

Opcional

Lista que contém uma ou mais roles da organização ou do projeto que recebem o alerta configurado. Se você incluir este parâmetro, o Atlas enviará alertas somente para usuários atribuídos aos papéis que você especificar na lista. Se você omitir este parâmetro, o Atlas enviará alertas para usuários atribuídos a qualquer papel.

O Atlas Kubernetes Operator aceita os seguintes valores:

GROUP_CLUSTER_MANAGER
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
GROUP_OWNER
GROUP_READ_WRITE
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY

O Atlas Kubernetes Operator aplica esta configuração quando você define spec.alertConfigurations.notifications.typeName para um dos seguintes valores:

GROUP
ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave API para PagerDuty. Se você deseja notificações por meio do PagerDuty, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.serviceKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de API para PagerDuty. Se quiser notificações por meio do PagerDuty, especifique essa configuração.

spec.alertConfigurations.notifications.severity

Tipo: string

Opcional

Grau de seriedade dado a esta notificação.

O Atlas Kubernetes Operator aceita os seguintes valores:

CRITICAL
ERROR
WARNING

spec.alertConfigurations.notifications.smsEnabled

Tipo: booleano

Condicional

Sinalizador que indica se o Atlas envia notificações de mensagens de texto.

O Atlas Kubernetes Operator exige esta configuração quando você configura o spec.alertConfigurations.notifications.typeName para um dos seguintes valores:

GROUP
ORG
TEAM

spec.alertConfigurations.notifications.teamId

Tipo: string

Condicional

Sequência única de 24 dígitos hexadecimais que identifica uma equipe Atlas.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para TEAM.

spec.alertConfigurations.notifications.teamName

Tipo: string

Condicional

Nome da equipe Atlas que recebe esta notificação.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para TEAM.

spec.alertConfigurations.notifications.typeName

Tipo: string

Condicional

Etiqueta legível para humanos que exibe o tipo de notificação de alerta. Esta configuração é exigida se você especificar um valor para a configuração spec.alertConfigurations.notifications . O Atlas suporta os seguintes valores:

DATADOG
EMAIL
OPS-GENIE
ORG
PAGER_DUTY
PROMETHEUS
SLACK
SMS
TEAM
USER
VICTOR_OPS
WEBHOOK

spec.alertConfigurations.notifications.username

Tipo: string

Condicional

Nome de usuário do Atlas da pessoa para quem o Atlas envia notificações. Especifique somente usuários do Atlas que pertencem ao projeto que possui a configuração de alerta.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para USER.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave API para Splunk On-Call. Se você quiser notificações por meio do Splunk On-Call, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.alertConfigurations.notifications.victorOpsSecretRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de API para o Splunk On-Call. Se quiser notificações pelo Splunk On-Call, especifique essa configuração.

spec.alertConfigurations.notifications.victorOpsRoutingKey

Tipo: string

Condicional

Chave de roteamento que o Atlas precisa para enviar notificações de alerta para o Splunk On-Call. Se a chave posteriormente se tornar inválida, o Atlas enviará um e-mail aos proprietários do projeto. Se a chave permanecer inválida, o Atlas a removerá.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para VICTOR_OPS.

spec.alertConfigurations.notifications.webhookSecret

Tipo: string

Opcional

Segredo de autenticação para um alerta baseado em webhook.

O Atlas Kubernetes Operator aplica essa configuração se você definir spec.alertConfigurations.notifications.typeName como WEBHOOK.

spec.alertConfigurations.notifications.webhookUrl

Tipo: string

Condicional

String que indica a URL do webhook.

O Atlas Kubernetes Operator exige esta configuração se você configurar o spec.alertConfigurations.notifications.typeName para WEBHOOK.

spec.alertConfigurations.threshold

Tipo: objeto

Condicional

Limite que Atlas Triggers um alerta quando excedido.

O Atlas Kubernetes Operator aplica essa configuração se você definir spec.alertConfigurations.eventTypeName como um valor diferente de OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.threshold.operator

Tipo: string

Condicional

Operador de comparação a ser aplicado quando o Atlas verificar o valor da métrica atual.

O Atlas Kubernetes Operator aceita os seguintes valores:

GREATER_THAN
LESS_THAN

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.threshold .

spec.alertConfigurations.threshold.threshold

Tipo: número inteiro

Condicional

Valor da métrica que, quando excedido, Atlas Triggers um alerta.

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.threshold .

spec.alertConfigurations.threshold.units

Tipo: string

Condicional

Elemento que Express a quantidade. Você pode especificar um elemento de tempo, capacidade de armazenamento e assim por diante.

O Atlas Kubernetes Operator aceita os seguintes valores:

BITS
BYTES
DAYS
GIGABITS
GIGABYTES
HOURS
KILOBITS
KILOBYTES
MEGABITS
MEGABYTES
MILLISECONDS
MINUTES
PETABYTES
RAW
SECONDS
TERABYTES

O Atlas Kubernetes Operator exige esta configuração se você incluir o objeto spec.alertConfigurations.threshold .

spec.alertConfigurationSyncEnabled

Tipo: booleano

Opcional

Padrão: false

Sinalizador que indica se o Atlas Kubernetes Operator aplica as configurações de alerta de projeto definidas em spec.alertConfigurations. Se você omitir ou definir este parâmetro como false, o Atlas Kubernetes Operator não sincronizará as configurações de alerta do projeto com as definidas no recurso personalizado AtlasProject .

Para obter informações sobre como esta configuração interage com spec.withDefaultAlertsSettings, consulte as Considerações.

spec.auditing.auditAuthorizationSuccess

Tipo: booleano

Opcional

Padrão: false

Sinalizador que indica se deve direcionar o sistema de auditoria para capturar tentativas de autenticação bem-sucedidas para filtros de auditoria usando o evento de auditoria "atype" : "authCheck" . Para definir esse parâmetro como true, você deve definir spec.auditing.enabled como true. Para saber mais, consulte auditAuthorizationSuccess.

AVISO: se você ativar o auditAuthorizationSuccess, poderá impacto gravemente o desempenho do cluster. Tenha cuidado ao habilitar essa função.

spec.auditing.auditFilter

Tipo: string

Opcional

Filtro de auditoria formatado em JSON. Talvez seja necessário trocar a string JSON para remover caracteres que podem impedir a análise, como aspas simples ou duplas. Para especificar um valor para esta configuração, você deve configurar spec.auditing.enabled para true.

Para ver exemplos de filtros de auditoria, consulte Exemplo de filtros de auditoria. Para saber mais sobre como configurar filtros de auditoria MongoDB, consulte Configurar um filtro de auditoria personalizado.

spec.auditing.enabled

Tipo: booleano

Condicional

Padrão: false

Sinalizador que indica se a auditoria deve ser ativada para o projeto. Para especificar um valor para spec.auditing.auditFilter ou para definir spec.auditing.auditAuthorizationSuccess como true, você deve especificar essa configuração. Para saber mais, consulte Habilitar registros de auditoria.

spec.backupCompliancePolicyRef

Tipo: objeto

Condicional

Objeto que contém o nome e o namespace do segredo opaco que faz referência ao AtlasBackupCompliancePolicy Recurso Personalizado. Se você ativar a Política de compliance de backup, especifique este parâmetro.

spec.backupCompliancePolicyRef.name

Tipo: string

Condicional

Nome do segredo opaco que faz referência ao AtlasBackupCompliancePolicy Recurso Personalizado. Se você ativar a Política de compliance de backup, especifique este parâmetro.

spec.backupCompliancePolicyRef.namespace

Tipo: objeto

Condicional

Namespace do segredo opaco que faz referência ao AtlasBackupCompliancePolicy Recurso Personalizado. Se você ativar a Política de compliance de backup, especifique este parâmetro.

spec.connectionSecretRef.name

Tipo: string

Opcional

Nome do segredo opaco que contém um único password campo com o ID da organização e as chaves de API que o Atlas Kubernetes Operator usa para se conectar ao Atlas. Se não for especificado, o Atlas Kubernetes Operator utilizará o segredo global padrão.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.connectionSecretRef.namespace

Tipo: string

Opcional

Namespace que contém o segredo com o ID da organização e as chaves de API que o Atlas Kubernetes Operator usa para se conectar ao Atlas. Se não especificado, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace como o AtlasProject Recurso Personalizado .

spec.cloudProviderAccessRoles

Tipo: array

Obsoleto. Em vez disso, use spec.cloudProviderIntegrations .

Lista que contém suas configurações de acesso unificada do fornecedor de nuvem .

spec.cloudProviderAccessRoles.iamAssumedRoleArn

Tipo: string

Obsoleto. Em vez disso, use spec.cloudProviderIntegrations.iamAssumedRoleArn .

ARN da AWS exclusivo que identifica a função de acesso do IAM que o Atlas assume. Se você deseja definir o acesso unificado do fornecedor de nuvem, será necessário especificar essa configuração.

spec.cloudProviderAccessRoles.providerName

Tipo: string

Obsoleto. Em vez disso, use spec.cloudProviderIntegrations.providerName .

fornecedor de nuvem para o role de acesso que o Atlas assume. O Atlas Kubernetes Operator suporta AWS para acesso unificado ao fornecedor de nuvem. Se você deseja definir o acesso unificado do fornecedor de nuvem, será necessário especificar essa configuração.

spec.cloudProviderIntegrations

Tipo: array

Opcional

Lista que contém suas configurações de integração do fornecedor de nuvem unificado .

spec.cloudProviderIntegrations.iamAssumedRoleArn

Tipo: string

Condicional

ARN da Amazon Web Services exclusivo que identifica a função de acesso do IAM que o Atlas assume. Se você deseja definir integrações unificadas do fornecedor de nuvem, deve especificar essa configuração.

spec.cloudProviderIntegrations.providerName

Tipo: string

Condicional

Fornecedor de nuvem para o role de acesso que o Atlas assume. O Atlas Kubernetes Operator suporta AWS para integrações unificadas com fornecedores de nuvem. Se você deseja definir integrações unificadas do fornecedor de nuvem , deve especificar essa configuração.

spec.customRoles

Tipo: objeto

Opcional

Importante

Este parâmetro tornou-se obsoleto a partir da 2.6 versão. To create custom roles with Atlas Kubernetes Operator, use the AtlasCustomRole Custom Resource.

spec.encryptionAtRest

Tipo: array

Opcional

Lista que contém as configurações de criptografia em descanso usando chaves managed pelo cliente para o projeto.

spec.encryptionAtRest.awsKms

Tipo: objeto

Opcional

Lista que contém as configurações para usar o AWS KMS para encryption at rest usando chaves gerenciadas pelo cliente para o projeto.

spec.encryptionAtRest.enabled

Tipo: booleano

Opcional

Sinalizador que indica se esse projeto usa o Amazon Web Services KMS para criptografar dados em repouso. Para habilitar a criptografia em descanso usando o Amazon Web Services KMS, defina este parâmetro como true. Para desabilitar a criptografia em descanso usando o Amazon Web Services KMS, defina este parâmetro como false. Se você desabilitar a encryption at rest usando o AWS KMS, o Atlas Kubernetes Operator removerá os detalhes de configuração.

spec.encryptionAtRest.awsKms.region

Tipo: string

Opcional

Etiqueta que indica a região do Amazon Web Services onde está a chave mestra do cliente.

spec.encryptionAtRest.awsKms.secretRef.name

Tipo: string

Opcional

Nome do segredo opaco que contém suas credenciais do Amazon Web Services .

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.awsKms.secretRef.namespace

Tipo: string

Opcional

namespace que contém suas credenciais Amazon Web Services . Se não for especificado, esse parâmetro assumirá como padrão o namespace do recurso personalizado AtlasProject .

spec.encryptionAtRest.azureKeyVault

Tipo: objeto

Opcional

Lista que contém as configurações para usar o Azure Key Vault para criptografia em descanso usando chaves managed pelo cliente para o projeto.

spec.encryptionAtRest.azureKeyVault.azureEnvironment

Tipo: string

Opcional

Local de implantação do Azure onde residem as credenciais da conta do Azure . Os valores válidos incluem AZURE, AZURE_CHINA e AZURE_GERMANY.

spec.encryptionAtRest.azureKeyVault.clientID

Tipo: string

Opcional

Sequência exclusiva de 36 caracteres hexadecimais que identifica seu aplicativo Azure .

spec.encryptionAtRest.azureKeyVault.enabled

Tipo: booleano

Opcional

Sinalizador que indica se este projeto usa Chave Azure usando o cofre de chaves Azure , o Atlas Kubernetes Operator remove os detalhes de configuração.

spec.encryptionAtRest.azureKeyVault.resourceGroupName

Tipo: string

Opcional

Etiqueta que identifica o grupo de recursos do Azure que contém seu Azure Key Vault. O Azure exibe o nome do grupo de recursos na página de detalhes do grupo de recursos.

spec.encryptionAtRest.azureKeyVault.secretRef.name

Tipo: string

Opcional

Nome do segredo opaco que contém suas credenciais do Azure .

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.azureKeyVault.secretRef.namespace

Tipo: string

Opcional

namespace que contém suas credenciais do Azure . Se não for especificado, esse parâmetro assumirá como padrão o namespace do recurso personalizado AtlasProject .

spec.encryptionAtRest.azureKeyVault.tenantID

Tipo: string

Opcional

Sequência exclusiva de caracteres hexadecimais de 36 caracteres que identifica o locatário do Azure Active Directory dentro da sua assinatura do Azure . O Azure exibe a ID do locatário na página de propriedades do locatário.

spec.encryptionAtRest.googleCloudKms

Tipo: objeto

Opcional

Lista que contém as configurações para usar o GCP KMS para criptografia em descanso usando chaves gerenciadas pelo cliente para o projeto.

spec.encryptionAtRest.googleCloudKms.enabled`

Tipo: string

Opcional

Sinalizador que indica se esse projeto usa o GCP KMS para criptografar dados em repouso. Para habilitar a criptografia em descanso usando o GCP KMS, defina este parâmetro como true. Para desativar a criptografia em descanso usando o GCP KMS, defina este parâmetro como false. Se você desabilitar a criptografia em descanso usando o GCP KMS, o Atlas Kubernetes Operator removerá os detalhes de configuração.

spec.encryptionAtRest.googleCloudKms.secretRef.name

Tipo: string

Opcional

Nome do segredo opaco que contém suas GCP credenciais do .

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.encryptionAtRest.googleCloudKms.secretRef.namespace

Tipo: string

Opcional

namespace que contém suas credenciais do GCP. Se não for especificado, esse parâmetro assumirá como padrão o namespace do recurso personalizado AtlasProject .

spec.integrations

Tipo: array

Opcional

Lista que contém suas configurações de integração de terceiros . Os parâmetros que você deve especificar dependem do serviço de terceiros que você deseja configurar:

Serviço, serviço	Configurações
Todos	`spec.integrations.type`
Datadog	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
Equipes da Microsoft	`spec.integrations.microsoftTeamsWebhookURL`
Opsgenie	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
PagerDuty	`spec.integrations.serviceKeyRef.name` `spec.integrations.serviceKeyRef.namespace`
Prometeu(a)	`spec.integrations.enabled` `spec.integrations.passwordRef.name` `spec.integrations.passwordRef.namespace` `spec.integrations.scheme` `spec.integrations.serviceDiscovery` `spec.integrations.username`
Slack	`spec.integrations.apiTokenRef.name` `spec.integrations.apiTokenRef.namespace`
VictorOps	`spec.integrations.apiKeyRef.name` `spec.integrations.routingKeyRef.name` `spec.integrations.routingKeyRef.namespace`
Configurações do webhook	`spec.integrations.secretRef.name` `spec.integrations.secretRef.namespace` `spec.integrations.url`

spec.integrations.accountId

Tipo: string

Condicional

Sequência única que identifica sua conta do New Relic. Se você deseja integrar o New Relic, você deve especificar esta configuração.

spec.integrations.apiKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave API para Datadog, Opsgenie ou VictorOps. Se quiser integrar com Datadog, Opsgenie ou VictorOps, você deve especificar esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.apiKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de API para Datadog, Opsgenie ou VictorOps. Se você deseja integrar o Datadog, Opsgenie ou VictorOps, você deve especificar esta configuração.

spec.integrations.apiTokenRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com o token API para Slack. Se quiser integrar ao Slack, especifique essa configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.apiTokenRef.namespace

Tipo: string

Condicional

namespace que contém seu token de API para o Slack. Se quiser integrar ao Slack, você deverá especificar esta configuração.

spec.integrations.enabled

Tipo: booleano

Condicional

Sinalizador que indica se seu cluster tem o Prometheus habilitado. Se você deseja integrar ao Prometheus, você deve especificar esta configuração como true.

spec.integrations.licenseKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave de licença do New Relic. Se você deseja integrar ao New Relic, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.licenseKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de licença para o New Relic. Se você deseja integrar o New Relic, você deve especificar esta configuração.

spec.integrations.microsoftTeamsWebhookURL

Tipo: string

Condicional

String que especifica a URL do webhook de entrada da equipe Microsoft. Se você deseja integrar com a equipe Mircosoft, você deve especificar esta configuração.

spec.integrations.passwordRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a senha do Prometeus. Se você deseja integrar com Prometheus, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.passwordRef.namespace

Tipo: string

Condicional

namespace que contém sua senha Prometheus. Se você deseja integrar ao Prometheus, especifique esta configuração.

spec.integrations.readTokenRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave de query de insights para New Relic. Se você deseja integrar ao New Relic, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.readTokenRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de query do Insights para o New Relic. Se você deseja integrar o New Relic, você deve especificar esta configuração.

spec.integrations.region

Tipo: string

Condicional

Padrão: US

Valor da string que indica a URL da API a ser usada para Datadog ou Opsgenie. Se você deseja integrar com Datadog ou Opsgenie, você deve especificar esta configuração.

Os valores para Opsgenie incluem US ou EU.

O Atlas é compatível com as seguintes regiões do Datadog na API de administração do Atlas:

Região da API de administração do Atlas	Região do Datadog correspondente
`US`	`US1`
`US3`	`US3`
`US5`	`US5`
`EU`	`EU1`

O Datadog usa US1 (US na API de administração do Atlas) por padrão.

Para saber mais sobre as regiões de Datadog, consulte Sites de Datadog.

spec.integrations.routingKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave de roteamento para VictorOps. Se você deseja integrar ao VictorOps, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.routingKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de roteamento para VictorOps. Se você deseja integrar o VictorOps, você deve especificar esta configuração.

spec.integrations.secretRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com o segredo do webhook. Se você deseja integrar com as configurações do webhook, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.secretRef.namespace

Tipo: string

Condicional

namespace que contém seu segredo do webhook. Se quiser fazer a integração com as configurações do Webhook, especifique essa configuração.

spec.integrations.scheme

Tipo: string

Condicional

String que indica o esquema de protocolo Prometheus configurado para solicitações. Os valores incluem http ou https . Se você deseja integrar ao Prometheus, especifique esta configuração.

spec.integrations.serviceDiscovery

Tipo: string

Condicional

Etiqueta legível por humanos que indica o método de descoberta de serviço Prometheus a ser usado. Os valores incluem file ou http . Se você deseja integrar ao Prometheus, especifique esta configuração.

spec.integrations.serviceKeyRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com a chave de serviço para PagerDuty. Se você deseja integrar com PagerDuty, você deve especificar esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.serviceKeyRef.namespace

Tipo: string

Condicional

namespace que contém sua chave de serviço para PagerDuty. Se você deseja integrar ao PagerDuty, você deve especificar esta configuração.

spec.integrations.type

Tipo: string

Condicional

Valor da string que indica o serviço de terceiros para integração com o Atlas. Os valores incluem:

DATADOG
MICROSOFT_TEAMS
NEW_RELIC
OPS_GENIE
PAGER_DUTY
PROMETHEUS
SLACK
VICTOR_OPS
WEBHOOK

Se você deseja integrar com um serviço de terceiros, você deverá especificar esta configuração.

spec.integrations.url

Tipo: string

Condicional

String que especifica a URL do webhook. Se quiser fazer a integração com as configurações do Webhook, especifique essa configuração.

spec.integrations.username

Tipo: string

Condicional

Etiqueta legível para humanos que identifica o usuário Prometheus. Se você deseja integrar ao Prometheus, especifique esta configuração.

spec.integrations.writeTokenRef.name

Tipo: string

Condicional

Nome do segredo opaco que contém um único password campo com o token de escrita para New Relic. Se você deseja integrar ao New Relic, especifique esta configuração.

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

spec.integrations.writeTokenRef.namespace

Tipo: string

Condicional

namespace que contém seu token de escrita para o New Relic. Se você deseja integrar o New Relic, você deve especificar esta configuração.

spec.maintenanceWindow

Tipo: objeto

Opcional

Lista que contém suas configurações do período de manutenção. Você pode especificar os seguintes parâmetros do corpo:

Nome

Tipo

necessidade

Descrição

dayOfWeek

número

Obrigatório

Dia da semana em que você deseja que o período de manutenção comece, como um número inteiro baseado em 1.

Dia da semana	Inteiro
Domingo	1
Segunda-feira	2
Terça-feira	3
Quarta-feira	4
Quinta-feira	5
Sexta-feira	6
Sábado	7

hourOfDay

número

Obrigatório

Hora do dia em que você deseja que o período de manutenção comece. Este parâmetro utiliza o relógio de 24 horas, onde meia-noite é 0 e meio-dia é 12.

autoDeferOnceEnabled

booleano

Opcional

Sinalizador que indica se você deseja adiar todo o período de manutenção em uma semana em que elas serão acionadas.

Importante

Considerações sobre a janela de manutenção

Atividades de manutenção urgentes: Atividades de manutenção urgentes, como patches de segurança, não podem esperar pela janela escolhida. O Atlas iniciará essas atividades de manutenção quando necessário.
Operações de manutenção contínuas: Depois que a manutenção estiver agendada para o cluster, você não poderá alterar o período de manutenção até que o trabalho de manutenção vigente seja concluído.
A manutenção requer eleição do conjunto de réplicas: O Atlas executa a manutenção da mesma forma que o procedimento de manutenção descrito no Manual do MongoDB. Esse procedimento requer pelo menos uma eleição de conjunto de réplicas durante a janela de manutenção por conjunto de réplicas.
A manutenção começa o mais próximo possível da hora: A manutenção sempre começa o mais próximo possível da hora programada, mas atualizações de cluster em andamento ou problemas inesperados do sistema podem atrasar a hora de início.

spec.maintenanceWindow.autoDefer

Tipo: booleano

Condicional

Sinalizador que indica se o Atlas deve adiar todas as janelas de manutenção por uma semana após você ativá-las.

spec.maintenanceWindow.defer

Tipo: booleano

Condicional

Sinalizador que indica se o Atlas deve adiar a manutenção programada. Você deve agendar a manutenção antes de poder adiar a manutenção com êxito. spec.maintenanceWindow.defer e spec.maintenanceWindow.startASAP não podem ser definidos como true ao mesmo tempo.

Importante

Enquanto o spec.maintenanceWindow.defer está configurado para true, o Atlas Kubernetes Operator adia a manutenção programada toda vez que você aplica alterações no recurso personalizado do AtlasProject . Se você definir spec.maintenanceWindow.defer como true, deverá alterar spec.maintenanceWindow.defer para false depois de aplicar as alterações.

spec.maintenanceWindow.dayOfWeek

Tipo: número

Condicional

Um inteiro baseado que representa o dia da semana em que o período de manutenção é iniciado. Use a tabela a seguir para encontrar o número inteiro que corresponde a cada dia:

Dia da semana	Inteiro
Domingo	1
Segunda-feira	2
Terça-feira	3
Quarta-feira	4
Quinta-feira	5
Sexta-feira	6
Sábado	7

Se você deseja configurar o período de manutenção para seu projeto, você deve especificar esta configuração.

spec.maintenanceWindow.hourOfDay

Tipo: número

Condicional

Número inteiro com base zero que representa a hora do dia em que o período de manutenção começa, de acordo com um relógio de 24 horas. Use 0 para meia-noite e 12 para meio-dia. Se você deseja configurar o período de manutenção para seu projeto, você deve especificar esta configuração.

spec.maintenanceWindow.startASAP

Tipo: booleano

Condicional

Sinalizador que indica se o Atlas deve iniciar imediatamente a manutenção. spec.maintenanceWindow.defer e spec.maintenanceWindow.startASAP não podem ser definidos como true ao mesmo tempo.

Importante

Enquanto o spec.maintenanceWindow.startASAP está configurado para true, o Atlas Kubernetes Operator inicia a manutenção toda vez que você aplica alterações no recurso personalizado do AtlasProject . Se você definir spec.maintenanceWindow.startASAP como true, deverá alterar spec.maintenanceWindow.startASAP para false depois de aplicar as alterações.

spec.networkPeers

Tipo: array

Opcional

Lista que contém as configurações de Peering do projeto.

spec.regionUsageRestrictions

Tipo: string

Opcional

Designa a região do Amazon Web Services do projeto apenas para o Atlas for Government . Você pode especificar um dos seguintes valores:

NONE: Se você definir regionUsageRestrictions como NONE, o valor será padronizado como COMMERCIAL_FEDRAMP_REGIONS_ONLY. Este é o padrão se você omitir regionUsageRestrictions.
GOV_REGIONS_ONLY: indica que o projeto está restrito às regiões do Amazon Web Services GovCloud que atendem aos requisitos de segurança mais rigorosos do governo dos EUA. Para saber mais,consulte a documentação GovCloud do Amazon Web Services.
COMMERCIAL_FEDRAMP_REGIONS_ONLY: indica que o projeto está restrito ao Amazon Web Services FedRamp Regiões padrão moderadas.

spec.projectIpAccessList

Tipo: array

Obrigatório

Lista de acesso IP que concede acesso de rede ao cluster do Atlas no projeto. Você pode especificar os seguintes parâmetros do corpo:

Parâmetro	Tipo	necessidade	Descrição
awsSecurityGroup	string	Condicional	Identificador exclusivo do grupo de segurança Amazon Web Services para adicionar à lista de acesso. Sua entrada na lista de acesso pode incluir apenas um awsSecurityGroup, um cidrBlock ou um ipAddress. Você deve configurar o emparelhamento de VPC para seu projeto antes de adicionar um grupo de segurança do Amazon Web Services a uma lista de acesso.
cidrBlock	string	Condicional	Faixa de endereços IP na notação CIDR a ser adicionada à lista de acesso. Sua entrada na lista de acesso pode incluir apenas um awsSecurityGroup, um cidrBlock ou um ipAddress.
comment	string	Opcional	Comentário associado à entrada da lista de acesso.
deleteAfterDate	data	Opcional	Carimbo de data/hora na ISO 8601 formato de data e hora em UTC após o que o Atlas remove a entrada da lista de acesso. A data especificada deve ser no futuro e dentro de uma semana a partir do momento em que você faz a solicitação de API . IMPORTANTE: não é possível definir grupos de segurança Amazon Web Services como entradas de lista de acesso temporário. Você pode incluir uma ISO 8601 designador de fuso horário para garantir que a data de expiração ocorra em relação à hora local no fuso horário especificado.
ipAddress	string	Condicional	Endereço IP único a ser adicionado à lista de acesso. Mutuamente exclusivo com awsSecurityGroup e cidrBlock. Sua entrada na lista de acesso pode incluir apenas um awsSecurityGroup, um cidrBlock ou um ipAddress.

spec.settings

Tipo: objeto

Opcional

Lista que contém as configurações do seu projeto.

spec.settings.isCollectDatabaseSpecificsStatisticsEnabled

Tipo: booleano

Opcional

Sinalizador que indica se seu projeto tem a coleta de estatísticas do banco de dados em métricas de cluster habilitadas.

spec.settings.isDataExplorerEnabled

Tipo: booleano

Opcional

Sinalizador que indica se o seu projeto tem o Data Explorer habilitado.

spec.settings.isExtendedStorageSizesEnabled

Tipo: booleano

Opcional

Sinalizador que indica se os tamanhos de armazenamento estendidos devem ser habilitados para o projeto especificado. Para saber mais sobre como habilitar o armazenamento estendido, consulte Gerenciar configurações do projeto.

spec.settings.isPerformanceAdvisorEnabled

Tipo: booleano

Opcional

Sinalizador que indica se seu projeto tem o Performance Advisor habilitado.

spec.settings.isRealtimePerformancePanelEnabled

Tipo: booleano

Opcional

Sinalizador que indica se seu projeto tem o Painel de Desempenho em Tempo Real habilitado.

spec.settings.isSchemaAdvisorEnabled

Tipo: booleano

Opcional

Sinalizador que indica se o seu projeto tem o Schema Advisor habilitado.

spec.privateEndpoints

Tipo: array

Opcional

Lista que contém as configurações de endpoints privados do projeto.

spec.teams

Tipo: objeto

Opcional

objeto que contém as especificações da sua equipe. Para saber mais, consulte Configurar equipes.

spec.teams.teamRef.name

Tipo: string

Condicional

spec.teams.teamRef.namespace

Tipo: string

Condicional

namespace especificado no AtlasTeam Recurso personalizado se não for default.

spec.teams.teamRef.roles

Tipo: string

Condicional

Roles deAtlas user que uma equipe usa para esse projeto. Se você deseja atribuir uma equipe a este projeto, você deve especificar esta configuração.

spec.withDefaultAlertsSettings

Tipo: booleano

Opcional

Padrão: true

Sinalizador que indica se o Atlas Kubernetes Operator cria um projeto com as configurações de alerta padrão. Se omitido, o padrão é true.

Se você definir este parâmetro para false 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 em projetos existentes.

Para obter informações sobre como esta configuração interage com spec.alertConfigurationSyncEnabled, consulte as Considerações.

spec.x509CertRef.name

Tipo: string

Opcional

Nome do kubernetes.io/tls segredo para o certificado X. .509

Atlas Kubernetes Operator observa segredos apenas com a etiqueta atlas.mongodb.com/type=credentials para evitar a exibição de segredos desnecessários .

O exemplo a seguir rotula um segredo:

kubectl label secret the-user-password atlas.mongodb.com/type=credentials

Voltar

Recursos personalizados

Sistema Atlas