AtlasProject Recurso personalizado

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.

Exemplo de equipes

The following example shows an AtlasProject custom resource specification that gives the green-leaf-team the Organization Owner role for this project. The team members are defined in the AtlasTeam custom resource.

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

The following example shows an AtlasProject custom resource specification that disables the collection of database statistics in cluster metrics, data explorer, Performance Advisor, Realtime Performance Panel, and Schema Advisor.

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 pode exceder 64 caracteres. O nome deve conter apenas letras, números, espaços, traços e sublinhados. Não pode ser modificado após a criação do projeto .

spec.alertConfigurations

Tipo: array de objetos

Opcional

List that contains alert configurations for this project.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

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 MongoDB Atlas Administration API.

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

List of rules that determine whether Atlas checks an object for the alert configuration. You can filter using the matchers array if spec.alertConfigurations.eventTypeName specifies an event for a host, replica set, or sharded cluster.

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

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.operator

Tipo: string

Condicional

Comparison operator to apply when checking the current metric value against spec.alertConfigurations.matchers.value.

O Atlas Kubernetes Operator aceita os seguintes valores:

• EQUALS

• CONTAINS

• STARTS_WITH

• ENDS_WITH

• NOT_EQUALS

• NOT_CONTAINS

• REGEX

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.matchers.value

Tipo: string

Condicional

Value to match or exceed using the specified spec.alertConfigurations.matchers.operator.

Atlas Kubernetes Operator requires this setting if you include an object in the spec.alertConfigurations.matchers array.

spec.alertConfigurations.metricThreshold

Tipo: objeto

Condicional

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

Atlas Kubernetes Operator requires this setting when spec.alertConfigurations.eventTypeName is OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.metricThreshold.metricName

Tipo: string

Condicional

Human-readable label that identifies the metric against which Atlas checks the configured spec.alertConfigurations.metricThreshold.threshold.

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 MongoDB Atlas Administration API.

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

spec.alertConfigurations.metricThreshold.threshold

Tipo: número inteiro

Condicional

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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.metricThreshold object.

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 segredo que contém um único campo password com seu token de API para o Slack.

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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.

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to SLACK.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

Tipo: string

Condicional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to EMAIL.

Atlas Kubernetes Operator doesn't require this setting to send email notifications when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

• USERS

To send emails to one Atlas user or group of users, set the spec.alertConfigurations.notifications.emailEnabled parameter.

spec.alertConfigurations.notifications.emailEnabled

Tipo: booleano

Condicional

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

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• 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á.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to MICROSOFT_TEAMS.

spec.alertConfigurations.notifications.mobileNumber

Tipo: string

Condicional

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

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to SMS.

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

Tipo: string

Condicional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to 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

Atlas Kubernetes Operator applies this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

Tipo: string

Condicional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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.smsEnabled

Tipo: booleano

Condicional

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

Atlas Kubernetes Operator requires this setting when you set spec.alertConfigurations.notifications.typeName to one of the following values:

• GROUP

• ORG

• TEAM

spec.alertConfigurations.notifications.teamId

Tipo: string

Condicional

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

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.teamName

Tipo: string

Condicional

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

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to TEAM.

spec.alertConfigurations.notifications.typeName

Tipo: string

Condicional

Human-readable label that displays the alert notification type. This setting is required if you specify a value for the spec.alertConfigurations.notifications setting. Atlas supports the following values:

• 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.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to USER.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

Tipo: string

Condicional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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á.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to VICTOR_OPS.

spec.alertConfigurations.notifications.webhookSecret

Tipo: string

Opcional

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

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.notifications.webhookUrl

Tipo: string

Condicional

String que indica a URL do webhook.

Atlas Kubernetes Operator requires this setting if you set spec.alertConfigurations.notifications.typeName to WEBHOOK.

spec.alertConfigurations.severityOverride

Tipo: string

Condicional

Overrides the Atlas-assigned default severity level for a project alert.

O Atlas Kubernetes Operator aceita os seguintes valores:

• CRITICAL

• ERROR

• WARNING

• INFO

spec.alertConfigurations.threshold

Tipo: objeto

Condicional

Limite que Atlas Triggers um alerta quando excedido.

Atlas Kubernetes Operator applies this setting if you set spec.alertConfigurations.eventTypeName to a value other than 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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurations.threshold.threshold

Tipo: número inteiro

Condicional

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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

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

Atlas Kubernetes Operator requires this setting if you include the spec.alertConfigurations.threshold object.

spec.alertConfigurationSyncEnabled

Tipo: booleano

Opcional

Padrão: false

Flag that indicates whether Atlas Kubernetes Operator applies the project alert settings defined in spec.alertConfigurations. If you omit or set to this parameter to false, Atlas Kubernetes Operator doesn't synchronize the project's alert configurations with the ones that you define in the AtlasProject custom resource.

For information on how this setting interacts with spec.withDefaultAlertsSettings, see the Considerations.

spec.auditing.auditAuthorizationSuccess

Tipo: booleano

Opcional

Padrão: false

Flag that indicates whether to direct the auditing system to capture successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. To set this parameter to true, you must set spec.auditing.enabled to true. To learn more, see 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

JSON-formatted auditing filter. You might need to escape the JSON string to remove characters that could prevent parsing, such as single or double-quotes. To specify a value for this setting, you must set spec.auditing.enabled to 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

Flag that indicates whether to enable auditing for the project. To specify a value for spec.auditing.auditFilter, or to set spec.auditing.auditAuthorizationSuccess to true, you must specify this setting. To learn more, see Enable Audit Logs.

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 Recurso PersonalizadoAtlasBackupCompliancePolicy . 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 Recurso PersonalizadoAtlasBackupCompliancePolicy . 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 campo password 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.

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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

Por padrão, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o recurso personalizado AtlasProject. Para armazenar segredos em outro namespace, especifique o parâmetro spec.connectionSecretRef.namespace.

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 for especificado, o Atlas Kubernetes Operator mantém segredos de conexão no mesmo namespace que o recurso personalizado AtlasProject.

spec.cloudProviderAccessRoles

Tipo: array

Deprecated. Use spec.cloudProviderIntegrations instead.

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

spec.cloudProviderAccessRoles.iamAssumedRoleArn

Tipo: string

Deprecated. Use spec.cloudProviderIntegrations.iamAssumedRoleArn instead.

ARN da Amazon Web Services 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

Deprecated. Use spec.cloudProviderIntegrations.providerName instead.

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

Obsoleto(a)

Importante

Este parâmetro é preterido a partir do Atlas Kubernetes Operator 2.6. Migre para o recurso personalizado AtlasPrivateEndpoint de acordo com o guia de migração.

Objeto que contém suas especificações de função personalizada .

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 este projeto usa AWS KMS para criptografar dados em repouso. Para habilitar a criptografia em descanso usando Amazon Web Services KMS, defina este parâmetro como true. Para desabilitar a criptografia em descanso usando o AWS KMS, defina este parâmetro como false. Se você desativar a criptografia em descanso usando o AWS KMS, o Atlas Kubernetes Operator remove os detalhes de configuração.

spec.encryptionAtRest.awsKms.region

Tipo: string

Opcional

Label that indicates the AWS region where the customer master key exists.

spec.encryptionAtRest.awsKms.secretRef.name

Tipo: string

Opcional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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 do Amazon Web Services. Se não especificado, este parâmetro assume o valor padrão do 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 encryption at rest usando chaves gerenciadas pelo cliente para o projeto.

spec.encryptionAtRest.azureKeyVault.azureEnvironment

Tipo: string

Opcional

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

spec.encryptionAtRest.azureKeyVault.clientID

Tipo: string

Opcional

string exclusiva de caracteres 36-hexadecimal 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.

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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 especificado, este parâmetro assume o valor padrão do namespace do recurso personalizado AtlasProject.

spec.encryptionAtRest.azureKeyVault.tenantID

Tipo: string

Opcional

string exclusiva de caracteres 36-hexadecimal que identifica o locatário do Azure Active Directory dentro de 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 managed pelo cliente para o projeto.

spec.encryptionAtRest.googleCloudKms.enabled`

Tipo: string

Opcional

Sinalizador que indica se este projeto usa o Google Cloud Platform KMS para criptografar dados em repouso. Para habilitar a criptografia em descanso usando o Google Cloud Platform KMS, defina este parâmetro como true. Para desativar a criptografia em descanso usando o Google Cloud Platform KMS, defina este parâmetro como false. Se você desativar a criptografia em descanso usando o Google Cloud Platform KMS, o Atlas Kubernetes Operator remove os detalhes da configuração.

spec.encryptionAtRest.googleCloudKms.secretRef.name

Tipo: string

Opcional

Nome do segredo opaco segredo que contém suas credenciais da Google Cloud Platform.

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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

Obsoleto(a)

Importante

Este parâmetro é preterido a partir do Atlas Kubernetes Operator 2.9. Migre para o recurso personalizado AtlasThirdPartyIntegration de acordo com o guia de migração.

Lista que contém suas configurações de integração de terceiros.

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

Flag that indicates whether Atlas should defer scheduled maintenance. You must schedule maintenance before you can successfully defer maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

Importante

While spec.maintenanceWindow.defer is set to true, Atlas Kubernetes Operator defers scheduled maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.defer to true, you should change spec.maintenanceWindow.defer to false after you apply changes.

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

Flag that indicates whether Atlas should immediately start maintenance. spec.maintenanceWindow.defer and spec.maintenanceWindow.startASAP can't both be set to true at the same time.

Importante

While spec.maintenanceWindow.startASAP is set to true, Atlas Kubernetes Operator starts maintenance every time you apply changes to the AtlasProject custom resource. If you set spec.maintenanceWindow.startASAP to true, you should change spec.maintenanceWindow.startASAP to false after you apply changes.

spec.networkPeers

Tipo: array

Opcional

Obsoleto(a)

Importante

Este parâmetro é preterido a partir do Atlas Kubernetes Operator 2.8. Migre para os recursos personalizados AtlasNetworkPeering e AtlasNetworkContainer de acordo com o guia de migração.

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

spec.regionUsageRestrictions

Tipo: string

Opcional

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

• NONE: o projeto não tem restrições de uso da região. Este é o valor padrão.

• GOV_REGIONS_ONLY: restringe o projeto às regiões de nuvem governamental que você especificar.

• COMMERCIAL_FEDRAMP_REGIONS_ONLY: indica que o projeto está restrito às regiões padrão do Amazon Web Services FedRamp Moderate.

spec.projectIpAccessList

Tipo: array

Obrigatório

Obsoleto(a)

Importante

Este parâmetro é preterido a partir do Atlas Kubernetes Operator 2.7. Migre para o recurso personalizado AtlasIPAccessList de acordo com o guia de migração.

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	Timestamp in ISO 8601 date and time format in UTC after which Atlas removes the entry from the access list. The specified date must be in the future and within one week of the time you make the API request. IMPORTANTE: não é possível definir grupos de segurança Amazon Web Services como entradas de lista de acesso temporário. Você pode incluir um designador de zona horário ISO 8601 para garantir que a data de expiração ocorra em relação à hora local no zona 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

Flag that indicates whether to enable extended storage sizes for the specified project. To learn more about enabling extended storage, see Manage Project Settings.

spec.settings.isPerformanceAdvisorEnabled

Tipo: booleano

Opcional

Flag that indicates whether your project has Performance Advisor enabled.

spec.settings.isRealtimePerformancePanelEnabled

Tipo: booleano

Opcional

Flag that indicates whether your project has Realtime Performance Panel enabled.

spec.settings.isSchemaAdvisorEnabled

Tipo: booleano

Opcional

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

spec.privateEndpoints

Tipo: array

Opcional

Obsoleto(a)

Importante

Este parâmetro é preterido a partir do Atlas Kubernetes Operator 2.6. Migre para o recurso personalizado AtlasPrivateEndpoint de acordo com o guia de migração.

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

Etiqueta legível por humanos do AtlasTeam Recurso Personalizado no metadata.name campo. Se você deseja atribuir uma equipe a este projeto, você deve especificar esta configuração.

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

Atlas User Roles that a team uses for this project. If you want to assign a team to this project, you must specify this setting.

spec.withDefaultAlertsSettings

Tipo: booleano

Opcional

Padrão: true

Flag that indicates whether Atlas Kubernetes Operator creates a project with the default alert configurations. If omitted, defaults to true.

If you use this setting, you must also set spec.alertConfigurationSyncEnabled to true for Atlas Kubernetes Operator to modify project alert configurations.

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.

For information on how this setting interacts with spec.alertConfigurationSyncEnabled, see the Considerations.

spec.x509CertRef.name

Tipo: string

Opcional

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

O Atlas Kubernetes atlas.mongodb.com/type=credentials Operator observa segredos apenas com a etiqueta 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