/ /

Recursos personalizados

Docs Home

MongoDB Atlas

MongoDB Atlas Kubernetes Operator

Recursos personalizados

Docs Home

MongoDB Atlas

MongoDB Atlas Kubernetes Operator

Recursos personalizados

`AtlasProject` Recurso personalizado

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas Operator.

El recurso personalizado AtlasProject configura el proyecto en Atlas. Al crear el recurso personalizado AtlasProject, el operador de Kubernetes de Atlas intenta crear un nuevo proyecto en Atlas.

Importante

Los recursos personalizados ya no eliminan objetos de forma predeterminada

El operador de Kubernetes de Atlas utiliza Archivosde configuración de recursos personalizados para administrar la configuración de Atlas. Sin embargo, a partir del Operador de 2.0 Kubernetes de Atlas, los recursos personalizados que elimine en Kubernetes ya no se eliminan (de forma predeterminada) en Atlas. En su lugar, el Operador de Kubernetes de Atlas simplemente deja de administrar esos recursos en Atlas. Por ejemplo, si elimina un AtlasProject Recurso Personalizado en Kubernetes, el Operador de Kubernetes de Atlas ya no elimina automáticamente el proyecto correspondiente de Atlas. Este cambio de comportamiento tiene como objetivo ayudar a prevenir eliminaciones accidentales o inesperadas. Para obtener más información, incluido cómo revertir este comportamiento al valor predeterminado utilizado antes del Operador de Kubernetes de Atlas.,2 0consulte Nuevo valor predeterminado: Protección contra eliminaciones en el Operador de Kubernetes 2 de0 Atlas..
De manera similar, Atlas Kubernetes Operator no elimina equipos de Atlas si los elimina de un proyecto Atlas en Kubernetes con Atlas Kubernetes Operator.

Defina explícitamente los detalles de configuración deseados para evitar el uso implícito de los valores predeterminados de Atlas. En algunos casos, heredar los valores predeterminados de Atlas puede generar un bucle de conciliación que impide que su recurso personalizado alcance el estado READY. Por ejemplo, definir explícitamente el comportamiento de escalado automático deseado en su recurso personalizado AtlasDeployment, como se muestra en el ejemplo incluido, garantiza que un tamaño de instancia estático en su recurso personalizado no se aplique repetidamente a una implementación de Atlas con el escalado automático habilitado.

autoScaling:
  diskGB:
    enabled: true
  compute:
    enabled: true
    scaleDownEnabled: true
    minInstanceSize: M30
    maxInstanceSize: M40

El operador de Atlas Kubernetes realiza una de las siguientes acciones:

Crea un nuevo proyecto en la organización que tiene la conexión secreta. configura.
Reutiliza un proyecto existente. En este caso, Atlas Kubernetes Operator verifica si existe un proyecto con spec.name. Si el proyecto existe, Atlas Kubernetes Operator omite su creación. Tras la conciliación, Atlas Kubernetes Operator actualiza el campo status.id con el ID del proyecto.

Puede usar el parámetro para spec.connectionSecretRef.name configurar el secreto de conexión del AtlasProject recurso personalizado. Este parámetro anula el global secreto de conexión predeterminado.

De forma predeterminada, Atlas Kubernetes Operator guarda los secretos de conexión en el mismo espacio de nombres que el AtlasProject recurso personalizado. Para almacenar los secretos en otro espacio de nombres, especifique el spec.connectionSecretRef.namespace parámetro.

Para conectarse a la API de administración de Atlas, Atlas Kubernetes Operator lee el ID de la organización y las claves de API de los secretos de Atlas Kubernetes Operator.

También puede editar la especificación de recurso personalizado AtlasProject para configurar las siguientes opciones:

Una lista de acceso IP con el parámetro. Esta lista otorga acceso a la red a los clústeres Atlas del spec.projectIpAccessList proyecto.
Equipos con el parámetro. Un equipo permite otorgar un rol de acceso a un grupo completo de usuarios de Atlas para un proyecto spec.teams específico.
La ventana de mantenimiento con el parámetro. Establece la hora y el día en que Atlas inicia el mantenimiento semanal de las implementaciones de bases de spec.maintenanceWindow datos.
Emparejamiento de red con el parámetro. El emparejamiento de red le permite conectarse de forma segura a spec.networkPeers su VPC deAWS, Azure o Google Cloud.
Cifrado en reposo mediante claves administradas por el cliente con el parámetrospec.encryptionAtRest. Este cifrado le permite añadir una capa adicional de seguridad mediante el KMS de su proveedor de nube junto con el motor de almacenamiento cifrado MongoDB.
Puntos finales privados con el spec.privateEndpoints parámetro.
Autenticación X.509 con el spec.x509CertRef.name parámetro.
Configuración del proyecto con el parámetro, incluidas configuraciones para habilitar y deshabilitar lo spec.settings siguiente:
- Recopilación de estadísticas de bases de datos en métricas de clúster
- Explorador de datos
- Performance Advisor
- Panel de rendimiento en tiempo real
- Asesor de esquemas
- Configuraciones de alertas del proyecto con los parámetros spec.alertConfigurationSyncEnabled spec.alertConfigurations y.
  Para obtener información sobre cómo interactúan estas configuraciones, consulte Consideraciones.

Si elimina el recurso AtlasProject de su clúster de Kubernetes, Atlas Kubernetes Operator eliminará el proyecto de Atlas. Debe eliminar todos los clústeres del proyecto previamente. De lo contrario, Atlas rechazará la solicitud de eliminación.

Ejemplo

El siguiente ejemplo muestra una especificación de recurso personalizada 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"

Ejemplo de Prometheus

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasProject que se integra con 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 obtener más información,consulte Integración con servicios de terceros.

Nota

Atlas Kubernetes Operator ofrece un panel de Grafana de muestra que puedes importar a Grafana.

Ejemplo de equipos

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que otorga al green-leaf-team el rol de Organization Owner para este proyecto. Los miembros del equipo están definidos en el recurso personalizado 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 obtener más información, consulte Configurar equipos.

Ejemplo de ventana de mantenimiento

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasProject que establece la ventana de mantenimiento a las 5:00 a. m. todos los martes con el aplazamiento automático deshabilitado:

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

Ejemplo de configuración del proyecto

El siguiente ejemplo muestra una AtlasProject especificación de recurso personalizado que deshabilita la recopilación de estadísticas de base de datos en las métricas de clúster, el explorador de datos, el Asesor de rendimiento,el Panel de rendimiento en tiempo real y el Asesor 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

Ejemplo de configuración de alertas

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que configura una alerta que se activa si la ventana del registro de operaciones alcanza menos de una 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

Ejemplo de configuración de alertas de terceros

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que configura una alerta que envía notificaciones a través de 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 sección describe los parámetros de recursos personalizados AtlasProject:

spec.name

Tipo: string

Requerido

Nombre del proyecto creado o actualizado en Atlas. El nombre no debe exceder 64 caracteres. Solo puede contener letras, números, espacios, guiones y guiones bajos.

spec.alertConfigurations

Tipo: matriz de objetos

Opcional

Lista que contiene configuraciones de alerta para este proyecto.

Si usa esta configuración, también debe establecer spec.alertConfigurationSyncEnabled en true para que Atlas Kubernetes Operator modifique las configuraciones de alerta del proyecto.

Si omite o deja esta configuración vacía, Atlas Kubernetes Operator no modifica la configuración de alertas del proyecto. Si se crea un proyecto, Atlas aplica la configuración de alertas predeterminada.

spec.alertConfigurations.eventTypeName

Tipo: string

Requerido

Evento que activa una alerta que describe esta configuración de alerta.

Para obtener más información sobre los valores que acepta Atlas Kubernetes Operator, consulte el esquema del cuerpo de la solicitud para el punto final Crear una configuración de alerta en un proyecto en la documentación de la API de administración de MongoDB Atlas.

spec.alertConfigurations.enabled

Tipo: booleano

Opcional

Por defecto: false

Indicador que indica si esta configuración de alerta está habilitada. Si se omite, el valor predeterminado es false.

spec.alertConfigurations.matchers

Tipo: matriz de objetos

Condicional

Lista de reglas que determinan si Atlas comprueba un objeto para la configuración de alertas. Puede filtrar mediante la matriz de coincidencias si spec.alertConfigurations.eventTypeName especifica un evento para un host, un conjunto de réplicas o un clúster fragmentado.

spec.alertConfigurations.matchers.fieldName

Tipo: string

Condicional

Etiqueta legible que identifica el parámetro en el objeto de destino que Atlas verifica. El parámetro debe cumplir todas las reglas para que Atlas verifique las configuraciones de alertas.

El operador Atlas Kubernetes acepta los siguientes valores:

CLUSTER_NAME
HOSTNAME
HOSTNAME_AND_PORT
PORT
REPLICA_SET_NAME
SHARD_NAME
TYPE_NAME

El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la spec.alertConfigurations.matchers matriz.

spec.alertConfigurations.matchers.operator

Tipo: string

Condicional

Operador de comparación a aplicar al verificar el valor métrico actual frente a spec.alertConfigurations.matchers.value.

El operador Atlas Kubernetes acepta los siguientes valores:

EQUALS
CONTAINS
STARTS_WITH
ENDS_WITH
NOT_EQUALS
NOT_CONTAINS
REGEX

El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la spec.alertConfigurations.matchers matriz.

spec.alertConfigurations.matchers.value

Tipo: string

Condicional

Valor spec.alertConfigurations.matchers.operator que debe coincidir o superarse utilizando el especificado.

El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la spec.alertConfigurations.matchers matriz.

spec.alertConfigurations.metricThreshold

Tipo: objeto

Condicional

Umbral para la métrica que, cuando se supera, activa una alerta.

El operador Atlas Kubernetes requiere esta configuración spec.alertConfigurations.eventTypeName cuando OUTSIDE_METRIC_THRESHOLD es.

spec.alertConfigurations.metricThreshold.metricName

Tipo: string

Condicional

Etiqueta legible por humanos que identifica la métrica con la que Atlas verifica el spec.alertConfigurations.metricThreshold.threshold configurado.

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.metricThreshold objeto.

spec.alertConfigurations.metricThreshold.mode

Tipo: string

Opcional

Por defecto: AVERAGE

Atlas calcula el valor métrico actual como un promedio.

El operador Atlas Kubernetes solo acepta un valor de AVERAGE.

spec.alertConfigurations.metricThreshold.operator

Tipo: string

Condicional

Operador de comparación a aplicar al verificar el valor de la métrica actual.

El operador Atlas Kubernetes acepta los siguientes valores:

GREATER_THAN
LESS_THAN

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.metricThreshold objeto.

spec.alertConfigurations.metricThreshold.threshold

Tipo: entero

Condicional

Valor de métrica que, cuando se excede, activa una alerta.

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.metricThreshold objeto.

spec.alertConfigurations.metricThreshold.units

Tipo: string

Condicional

Elemento utilizado para expresar la cantidad. Este valor puede ser un elemento de tiempo, capacidad de almacenamiento, etc.

El operador Atlas Kubernetes acepta los siguientes valores:

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

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.metricThreshold objeto.

spec.alertConfigurations.notifications

Tipo: arreglo

Condicional

Lista que describe las notificaciones que Atlas envía para las alertas que describe esta configuración de alerta.

spec.alertConfigurations.notifications.apiTokenRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un solo campo password con el token de API de Slack.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

Si desea recibir notificaciones a través de Slack, debe especificar esta configuración.

spec.alertConfigurations.notifications.apiTokenRef.namespace

Tipo: string

Condicional

Namespace que contiene tu token de API para Slack. Si deseas notificaciones a través de Slack, debes especificar esta configuración.

spec.alertConfigurations.notifications.channelName

Tipo: string

Condicional

Etiqueta legible por humanos que identifica el canal de Slack al que Atlas envía notificaciones de alerta.

El operador Atlas Kubernetes requiere esta configuración cuando se spec.alertConfigurations.notifications.typeName configura SLACK en.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave API de Datadog. Si desea recibir notificaciones a través de Datadog, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.alertConfigurations.notifications.datadogApiKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave API para Datadog. Si desea recibir notificaciones a través de Datadog, debe especificar esta configuración.

spec.alertConfigurations.notifications.datadogRegion

Tipo: string

Opcional

Por defecto: US

Región de Datadog que indica qué localizador uniforme de recursos (URL) API utilizar.

El operador Atlas Kubernetes acepta los siguientes valores:

US
EU

spec.alertConfigurations.notifications.delayMins

Tipo: entero

Opcional

Por defecto: 0

Número de minutos que Atlas espera después de detectar una condición de alerta antes de enviar la primera notificación.

spec.alertConfigurations.notifications.emailAddress

Tipo: string

Condicional

Dirección de correo electrónico a la que Atlas envía notificaciones de alerta.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece EMAIL en.

El operador Atlas Kubernetes no requiere esta configuración para enviar notificaciones por correo electrónico cuando configura en uno de los siguientes spec.alertConfigurations.notifications.typeName valores:

GROUP
ORG
TEAM
USERS

Para enviar correos electrónicos a un usuario de Atlas o a un grupo de usuarios, configure el parámetro.spec.alertConfigurations.notifications.emailEnabled

spec.alertConfigurations.notifications.emailEnabled

Tipo: booleano

Condicional

Bandera que indica si Atlas envía notificaciones por correo electrónico.

El operador Atlas Kubernetes requiere esta configuración cuando se establece en uno de los siguientes spec.alertConfigurations.notifications.typeName valores:

GROUP
ORG
TEAM

spec.alertConfigurations.notifications.intervalMin

Tipo: entero

Opcional

Número de minutos de espera entre notificaciones sucesivas. Atlas envía notificaciones hasta que alguien confirma la alerta no confirmada. El operador de Kubernetes de Atlas acepta valores mayores o iguales a 5.

Las notificaciones de PagerDuty, VictorOps y OpsGenie no utilizan este campo. Configure y administre el intervalo de notificación en cada uno de estos servicios.

spec.alertConfigurations.notifications.microsoftTeamsWebhookUrl

Tipo: string

Condicional

Localizador Uniforme de Recursos (URL) del Webhook de Microsoft Teams que Atlas necesita para enviar esta notificación a través de Microsoft Teams. Si la URL deja de ser válida posteriormente, Atlas envía un correo electrónico a los propietarios del proyecto. Si la clave sigue siendo inválida, Atlas la elimina.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece MICROSOFT_TEAMS en.

spec.alertConfigurations.notifications.mobileNumber

Tipo: string

Condicional

Número de teléfono móvil al que Atlas envía notificaciones de alerta.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece SMS en.

spec.alertConfigurations.notifications.opsGenieApiKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave API de Opsgenie. Si desea recibir notificaciones a través de Opsgenie, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.alertConfigurations.notifications.opsGenieApiKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave API para Opsgenie. Si desea recibir notificaciones a través de Opsgenie, debe especificar esta configuración.

spec.alertConfigurations.notifications.opsGenieRegion

Tipo: string

Opcional

Por defecto: US

Región de Opsgenie que indica qué localizador uniforme de recursos (URL) API utilizar.

El operador Atlas Kubernetes acepta los siguientes valores:

US
EU

El operador Atlas Kubernetes aplica esta configuración spec.alertConfigurations.notifications.typeName si OPS_GENIE establece en.

spec.alertConfigurations.notifications.roles

Tipo: arreglo

Opcional

Lista que contiene uno o más roles de organización o proyecto que reciben la alerta configurada. Si incluye este parámetro, Atlas envía alertas solo a los usuarios asignados a los roles que especifique en la lista. Si omite este parámetro, Atlas envía alertas a los usuarios asignados a cualquier rol.

El operador Atlas Kubernetes acepta los siguientes 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

El operador de Kubernetes de Atlas aplica esta configuración cuando defines spec.alertConfigurations.notifications.typeName en uno de los siguientes valores:

GROUP
ORG

spec.alertConfigurations.notifications.serviceKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave API de PagerDuty. Si desea recibir notificaciones a través de PagerDuty, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.alertConfigurations.notifications.serviceKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave API para PagerDuty. Si desea recibir notificaciones a través de PagerDuty, debe especificar esta configuración.

spec.alertConfigurations.notifications.severity

Tipo: string

Opcional

Grado de seriedad dado a esta notificación.

El operador Atlas Kubernetes acepta los siguientes valores:

CRITICAL
ERROR
WARNING

spec.alertConfigurations.notifications.smsEnabled

Tipo: booleano

Condicional

Bandera que indica si Atlas envía notificaciones de mensajes de texto.

El operador Atlas Kubernetes requiere esta configuración cuando se establece en uno de los siguientes spec.alertConfigurations.notifications.typeName valores:

GROUP
ORG
TEAM

spec.alertConfigurations.notifications.teamId

Tipo: string

Condicional

Cadena de dígitos hexadecimales 24única que identifica a un equipo Atlas.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece TEAM en.

spec.alertConfigurations.notifications.teamName

Tipo: string

Condicional

Nombre del equipo Atlas que recibe esta notificación.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece TEAM en.

spec.alertConfigurations.notifications.typeName

Tipo: string

Condicional

Etiqueta legible que muestra el tipo de notificación de alerta. Esta configuración es obligatoria si se especifica un valor para la configuración. Atlas admite los siguientes spec.alertConfigurations.notifications valores:

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

spec.alertConfigurations.notifications.username

Tipo: string

Condicional

Nombre de usuario de Atlas a quien Atlas envía notificaciones. Especifique solo los usuarios de Atlas que pertenecen al proyecto propietario de la configuración de alertas.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece USER en.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave API de Splunk On-Call. Si desea recibir notificaciones a través de Splunk On-Call, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.alertConfigurations.notifications.victorOpsSecretRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave API para Splunk On-Call. Si desea recibir notificaciones a través de Splunk On-Call, debe especificar esta configuración.

spec.alertConfigurations.notifications.victorOpsRoutingKey

Tipo: string

Condicional

Clave de enrutamiento que Atlas necesita para enviar notificaciones de alerta a Splunk On-Call. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico a los propietarios del proyecto. Si la clave sigue siendo válida, Atlas la elimina.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece VICTOR_OPS en.

spec.alertConfigurations.notifications.webhookSecret

Tipo: string

Opcional

Secreto de autenticación para una alerta basada en webhook.

El operador Atlas Kubernetes aplica esta configuración spec.alertConfigurations.notifications.typeName si WEBHOOK establece en.

spec.alertConfigurations.notifications.webhookUrl

Tipo: string

Condicional

String que indica la URL de tu webhook.

El operador Atlas Kubernetes requiere esta configuración si spec.alertConfigurations.notifications.typeName establece WEBHOOK en.

spec.alertConfigurations.threshold

Tipo: objeto

Condicional

Límite que activa una alerta cuando se excede.

El operador Atlas Kubernetes aplica esta configuración si establece en un valor spec.alertConfigurations.eventTypeName distinto OUTSIDE_METRIC_THRESHOLD de.

spec.alertConfigurations.threshold.operator

Tipo: string

Condicional

Operador de comparación que se aplicará cuando Atlas verifique el valor de la métrica actual.

El operador Atlas Kubernetes acepta los siguientes valores:

GREATER_THAN
LESS_THAN

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.threshold objeto.

spec.alertConfigurations.threshold.threshold

Tipo: entero

Condicional

Valor de métrica que, cuando se excede, activa una alerta.

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.threshold objeto.

spec.alertConfigurations.threshold.units

Tipo: string

Condicional

Elemento que expresa la cantidad. Puede especificar un elemento de tiempo, capacidad de almacenamiento, etc.

El operador Atlas Kubernetes acepta los siguientes valores:

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

El operador Atlas Kubernetes requiere esta configuración si incluye el spec.alertConfigurations.threshold objeto.

spec.alertConfigurationSyncEnabled

Tipo: booleano

Opcional

Por defecto: false

Indicador que indica si Atlas Kubernetes Operator aplica la configuración de alertas del proyecto definida en. Si omite este parámetro o lo spec.alertConfigurations establece false en, Atlas Kubernetes Operator no sincroniza las configuraciones de alertas del proyecto con las definidas en el AtlasProject recurso personalizado.

Para obtener información sobre cómo esta configuración interactúa con,spec.withDefaultAlertsSettings consulte Consideraciones.

spec.auditing.auditAuthorizationSuccess

Tipo: booleano

Opcional

Por defecto: false

Marca que indica si se debe indicar al sistema de auditoría que capture los intentos de autenticación correctos para los filtros de auditoría mediante el "atype" : "authCheck" evento de auditoría. Para establecer este parámetro true en, debe spec.auditing.enabled establecer true en. Para obtener más información, consulte auditAuthorizationSuccess.

ADVERTENCIA: si habilita auditAuthorizationSuccess, podría afectar gravemente el rendimiento del clúster. Activa esta opción con precaución.

spec.auditing.auditFilter

Tipo: string

Opcional

Filtro de auditoría con formato JSON. Es posible que deba escapar la cadena JSON para eliminar caracteres que podrían impedir el análisis, como comillas simples o dobles. Para especificar un valor para esta configuración, debe spec.auditing.enabled establecer true en.

Para ver ejemplos de filtros de auditoría, consulte Ejemplos de filtros de auditoría. Para obtener más información sobre la configuración de filtros de auditoría de MongoDB, consulte Configurar unfiltro de auditoría personalizado.

spec.auditing.enabled

Tipo: booleano

Condicional

Por defecto: false

Indicador que indica si se debe habilitar la auditoría del proyecto. Para especificar un valor para spec.auditing.auditFilter o para spec.auditing.auditAuthorizationSuccess establecer true en, debe especificar esta configuración. Para obtener más información, consulte Habilitar registros de auditoría.

spec.backupCompliancePolicyRef

Tipo: objeto

Condicional

Objeto que contiene el nombre y namespace del secreto opaco que hace referencia al AtlasBackupCompliancePolicy recurso personalizado. Si activas una Política de cumplimiento de copias de seguridad, debes especificar este parámetro.

spec.backupCompliancePolicyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que hace referencia al AtlasBackupCompliancePolicy recurso personalizado. Si habilita una política de cumplimiento de copias de seguridad, debe especificar este parámetro.

spec.backupCompliancePolicyRef.namespace

Tipo: objeto

Condicional

Espacio de nombres del secreto opaco que hace referencia al AtlasBackupCompliancePolicy recurso personalizado. Si habilita una política de cumplimiento de copias de seguridad, debe especificar este parámetro.

spec.connectionSecretRef.name

Tipo: string

Opcional

Nombre del secreto opaco que contiene un único password campo con el ID de la organización y las claves de API que Atlas Kubernetes Operator utiliza para conectarse a Atlas. Si no se especifica, Atlas Kubernetes Operator utiliza el global secreto predeterminado.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.connectionSecretRef.namespace

Tipo: string

Opcional

Espacio de nombres que contiene el secreto con el ID de organización y las claves de API que Atlas Kubernetes Operator utiliza para conectarse a Atlas. Si no se especifica, Atlas Kubernetes Operator guarda los secretos de conexión en el mismo espacio de nombres que el AtlasProject recurso personalizado.

spec.cloudProviderAccessRoles

Tipo: arreglo

Obsoleto. Utiliza spec.cloudProviderIntegrations en su lugar.

Lista que contiene la configuración de acceso unificada a su proveedor de nube.

spec.cloudProviderAccessRoles.iamAssumedRoleArn

Tipo: string

Obsoleto. Utiliza spec.cloudProviderIntegrations.iamAssumedRoleArn en su lugar.

ARN único de AWS que identifica el rol de acceso de IAM que Atlas asume. Si desea configurar el acceso unificado al proveedor de nube, debe especificar esta configuración.

spec.cloudProviderAccessRoles.providerName

Tipo: string

Obsoleto. Utiliza spec.cloudProviderIntegrations.providerName en su lugar.

Proveedor de nube para el rol de acceso que asume Atlas. El operador de Kubernetes de Atlas admite AWS para el acceso unificado al proveedor de nube. Si desea configurar el acceso unificado al proveedor de nube, debe especificar esta configuración.

spec.cloudProviderIntegrations

Tipo: arreglo

Opcional

Lista que contiene la configuración de integración de su proveedor de nube unificado.

spec.cloudProviderIntegrations.iamAssumedRoleArn

Tipo: string

Condicional

ARN único de AWS que identifica el rol de acceso de IAM que Atlas asume. Si desea configurar integraciones unificadas con proveedores de nube, debe especificar esta configuración.

spec.cloudProviderIntegrations.providerName

Tipo: string

Condicional

Proveedor de nube para el rol de acceso que asume Atlas. El operador de Kubernetes de Atlas admite AWS para integraciones unificadas con proveedores de nube. Si desea configurar integraciones unificadas con proveedores de nube, debe especificar esta configuración.

spec.customRoles

Tipo: objeto

Opcional

Objeto que contiene sus especificaciones de rol personalizadas.

Importante

Este parámetro queda obsoleto a partir de la versión 2.6. Para crear roles personalizados con Atlas Kubernetes Operator, utiliza el AtlasCustomRole recurso personalizado.

Para obtener más información sobre los parámetros de configuración disponibles en la API, consulte la API de roles de base de datos personalizados de Atlas.

spec.encryptionAtRest

Tipo: arreglo

Opcional

Lista que contiene las configuraciones para el cifrado en reposo utilizando claves administradas por el cliente para el proyecto.

spec.encryptionAtRest.awsKms

Tipo: objeto

Opcional

Lista que contiene las configuraciones para usar AWS KMS para el cifrado en reposo utilizando claves administradas por el cliente para el proyecto.

spec.encryptionAtRest.enabled

Tipo: booleano

Opcional

Marca que indica si este proyecto utiliza AWS KMS para cifrar datos en reposo. Para habilitar el cifrado en reposo con AWS KMS, configure este parámetro true en. Para deshabilitar el cifrado en reposo con AWS KMS, configure este parámetro false en. Si deshabilita el cifrado en reposo con AWS KMS, Atlas Kubernetes Operator elimina los detalles de configuración.

spec.encryptionAtRest.awsKms.region

Tipo: string

Opcional

Etiqueta que indica la región de AWS donde existe la clave maestra del cliente.

spec.encryptionAtRest.awsKms.secretRef.name

Tipo: string

Opcional

Nombre del secreto opaco que contiene sus credenciales de AWS.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.encryptionAtRest.awsKms.secretRef.namespace

Tipo: string

Opcional

Espacio de nombres que contiene sus credenciales de AWS. Si no se especifica, este parámetro toma como valor predeterminado el AtlasProject espacio de nombres del recurso personalizado.

spec.encryptionAtRest.azureKeyVault

Tipo: objeto

Opcional

Lista que contiene las configuraciones para usar Azure Key Vault para el cifrado en reposo mediante claves administradas por el cliente para el proyecto.

spec.encryptionAtRest.azureKeyVault.azureEnvironment

Tipo: string

Opcional

Ubicación de implementación deAzure donde residen las credenciales de la cuenta de Azure. Los valores válidos AZURE son, AZURE_CHINA AZURE_GERMANYy.

spec.encryptionAtRest.azureKeyVault.clientID

Tipo: string

Opcional

string de 36 caracteres hexadecimales única que identifica su aplicación de Azure .

spec.encryptionAtRest.azureKeyVault.enabled

Tipo: booleano

Opcional

Bandera que indica si este proyecto usa Azure Key Vault. El operador Atlas Kubernetes elimina los detalles de configuración.

spec.encryptionAtRest.azureKeyVault.resourceGroupName

Tipo: string

Opcional

Etiqueta que identifica el grupo de recursos Azure que contiene tu Azure Key Vault. Azure muestra el nombre del grupo de recursos en la página de detalles del grupo de recursos.

spec.encryptionAtRest.azureKeyVault.secretRef.name

Tipo: string

Opcional

Nombre del secreto opaco que contiene sus credenciales de Azure.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.encryptionAtRest.azureKeyVault.secretRef.namespace

Tipo: string

Opcional

Espacio de nombres que contiene sus credenciales de Azure. Si no se especifica, este parámetro toma como valor predeterminado el AtlasProject espacio de nombres del recurso personalizado.

spec.encryptionAtRest.azureKeyVault.tenantID

Tipo: string

Opcional

string única de caracteres hexadecimales de 36 que identifica al inquilino Azure Active directorio dentro de su Azure suscripción. Azure muestra el ID de inquilino en la página de propiedades del inquilino.

spec.encryptionAtRest.googleCloudKms

Tipo: objeto

Opcional

Lista que contiene las configuraciones para usar Google Cloud KMS para el cifrado en reposo mediante claves administradas por el cliente para el proyecto.

spec.encryptionAtRest.googleCloudKms.enabled`

Tipo: string

Opcional

Marca que indica si este proyecto usa Google Cloud KMS para cifrar datos en reposo. Para habilitar el cifrado en reposo con Google Cloud KMS, configure este parámetro true en. Para deshabilitar el cifrado en reposo con Google Cloud KMS, configure este parámetro false en. Si deshabilita el cifrado en reposo con Google Cloud KMS, Atlas Kubernetes Operator elimina los detalles de configuración.

spec.encryptionAtRest.googleCloudKms.secretRef.name

Tipo: string

Opcional

Nombre del secreto opaco que contiene sus credenciales de Google Cloud.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.encryptionAtRest.googleCloudKms.secretRef.namespace

Tipo: string

Opcional

Espacio de nombres que contiene tus credenciales de Google Cloud. Si no se especifica, este parámetro toma como valor predeterminado el espacio de nombres del recurso personalizado AtlasProject.

spec.integrations

Tipo: arreglo

Opcional

Lista que contiene la configuración de integración de terceros. Los parámetros que debe especificar dependen del servicio de terceros que desee configurar:

Servicio	Configuraciones
Todo	`spec.integrations.type`
Datadog	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
Microsoft Teams	`spec.integrations.microsoftTeamsWebhookURL`
Opsgenie	`spec.integrations.apiKeyRef.name` `spec.integrations.apiKeyRef.namespace` `spec.integrations.region`
PagerDuty	`spec.integrations.serviceKeyRef.name` `spec.integrations.serviceKeyRef.namespace`
Prometheus	`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`
Configuración del webhook	`spec.integrations.secretRef.name` `spec.integrations.secretRef.namespace` `spec.integrations.url`

spec.integrations.accountId

Tipo: string

Condicional

Cadena única que identifica su cuenta de New Relic. Si desea integrarla con New Relic, debe especificar esta configuración.

spec.integrations.apiKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave API para Datadog, Opsgenie o VictorOps. Si desea integrarlo con Datadog, Opsgenie o VictorOps, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.apiKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave API para Datadog, Opsgenie o VictorOps. Si desea integrar con Datadog, Opsgenie o VictorOps, debe especificar esta configuración.

spec.integrations.apiTokenRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con el token de API para Slack. Si desea integrarlo con Slack, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.apiTokenRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene tu token de API para Slack. Si deseas integrarlo con Slack, debes especificar esta configuración.

spec.integrations.enabled

Tipo: booleano

Condicional

Indicador que indica si su clúster tiene Prometheus habilitado. Si desea integrarlo con Prometheus, debe especificar esta configuración como true.

spec.integrations.licenseKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un solo password campo con la clave de licencia de New Relic. Si desea integrarlo con New Relic, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.licenseKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave de licencia de New Relic. Si desea integrarlo con New Relic, debe especificar esta configuración.

spec.integrations.microsoftTeamsWebhookURL

Tipo: string

Condicional

Cadena que especifica el webhook entrante de Microsoft Teams URL. Si deseas integrar con Microsoft Teams, debes especificar esta configuración.

spec.integrations.passwordRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la contraseña de Prometheus. Si desea integrarlo con Prometheus, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.passwordRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su contraseña de Prometheus. Si desea integrarse con Prometheus, debe especificar esta configuración.

spec.integrations.readTokenRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un solo campo password con la clave de query Insights para New Relic. Si desea integrarse con New Relic, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.readTokenRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave de consulta de Insights para New Relic. Si desea integrarlo con New Relic, debe especificar esta configuración.

spec.integrations.region

Tipo: string

Condicional

Por defecto: US

Valor de cadena que indica la URL de la API que se usará para Datadog u Opsgenie. Si desea integrar con Datadog u Opsgenie, debe especificar esta configuración.

Los valores para Opsgenie incluyen US o EU.

Atlas admite las siguientes regiones de Datadog en la API de administración de Atlas:

Región API de administración de Atlas	Región correspondiente de Datadog
`US`	`US1`
`US3`	`US3`
`US5`	`US5`
`EU`	`EU1`

Datadog utiliza US1 (US en la API de administración de Atlas) de manera predeterminada.

Para aprender más sobre las regiones de Datadog, se puede consultar Sitios de Datadog.

spec.integrations.routingKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave de enrutamiento para VictorOps. Si desea integrarlo con VictorOps, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.routingKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave de enrutamiento para VictorOps. Si desea integrarlo con VictorOps, debe especificar esta configuración.

spec.integrations.secretRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con el secreto del webhook. Si desea integrarlo con la configuración del webhook, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.secretRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene el secreto de tu webhook. Si deseas integrarlo con la configuración de webhook, debes especificar esta configuración.

spec.integrations.scheme

Tipo: string

Condicional

Cadena que indica el esquema de protocolo de Prometheus configurado para las solicitudes. Los valores incluyen http o https. Si desea integrar con Prometheus, debe especificar esta configuración.

spec.integrations.serviceDiscovery

Tipo: string

Condicional

Etiqueta legible que indica el método de descubrimiento de servicios de Prometheus que se utilizará. Los valores incluyen file o http. Si desea integrar con Prometheus, debe especificar esta configuración.

spec.integrations.serviceKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con la clave de servicio de PagerDuty. Si desea integrarlo con PagerDuty, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.serviceKeyRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su clave de servicio para PagerDuty. Si desea integrarlo con PagerDuty, debe especificar esta configuración.

spec.integrations.type

Tipo: string

Condicional

Valor de cadena que indica el servicio de terceros que se integrará con Atlas. Los valores incluyen:

DATADOG
MICROSOFT_TEAMS
NEW_RELIC
OPS_GENIE
PAGER_DUTY
PROMETHEUS
SLACK
VICTOR_OPS
WEBHOOK

Si desea integrarse con un servicio de terceros, debe especificar esta configuración.

spec.integrations.url

Tipo: string

Condicional

Cadena que especifica la URL de tu webhook. Si deseas integrarlo con la configuración del webhook, debes especificar esta configuración.

spec.integrations.username

Tipo: string

Condicional

Etiqueta legible que identifica al usuario de Prometheus. Si desea integrarse con Prometheus, debe especificar esta configuración.

spec.integrations.writeTokenRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un único password campo con el token de escritura para New Relic. Si desea integrarlo con New Relic, debe especificar esta configuración.

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

spec.integrations.writeTokenRef.namespace

Tipo: string

Condicional

Espacio de nombres que contiene su token de escritura para New Relic. Si desea integrarlo con New Relic, debe especificar esta configuración.

spec.maintenanceWindow

Tipo: objeto

Opcional

Lista que contiene la configuración de la ventana de mantenimiento. Puede especificar los siguientes parámetros del cuerpo:

Nombre

Tipo

Necesidad

Descripción

día de la semana

Número

Requerido

Día de la semana en el que desea que comience el periodo de mantenimiento, como un entero basado en 1.

Día de la semana	entero
Domingo	1
Lunes	2
Martes	3
Miércoles	4
Jueves	5
Viernes	6
Sábado	7

horaDelDía

Número

Requerido

Hora del día en que desea que comience la ventana de mantenimiento. Este parámetro utiliza el 24reloj de horas, donde la medianoche es 0 y el mediodía 12 es.

autoDeferOnceEnabled

booleano

Opcional

Bandera que indica si desea aplazar todas las ventanas de mantenimiento una semana antes de que se activen.

Importante

Consideraciones sobre el periodo de mantenimiento

actividades de mantenimiento urgentes: Las actividades de mantenimiento urgentes, como los parches de seguridad, no pueden esperar a la fecha elegida. Atlas las iniciará cuando sea necesario.
Operaciones de mantenimiento continuas: Una vez programado el mantenimiento para su clúster, no podrá cambiar su ventana de mantenimiento hasta que se hayan completado los esfuerzos de mantenimiento actuales.
El mantenimiento requiere elecciones de Set de réplicas: Atlas realiza el mantenimiento de la misma manera que el procedimiento de mantenimiento descrito en el Manual de MongoDB. Este procedimiento requiere al menos una elección de Set de réplicas durante el periodo de mantenimiento por Set de réplicas.
El mantenimiento comienza lo más cerca posible de la hora: El mantenimiento siempre comienza lo más cerca posible de la hora programada, pero las actualizaciones del clúster en curso o problemas inesperados del sistema podrían retrasar la hora de inicio.

spec.maintenanceWindow.autoDefer

Tipo: booleano

Condicional

Bandera que indica si Atlas debe posponer todas las ventanas de mantenimiento durante una semana después de habilitarlas.

spec.maintenanceWindow.defer

Tipo: booleano

Condicional

Indicador que indica si Atlas debe aplazar el mantenimiento programado. Debe programarlo para poder aplazarlo correctamente. spec.maintenanceWindow.defer y no pueden spec.maintenanceWindow.startASAP configurarse true simultáneamente en.

Importante

Si spec.maintenanceWindow.defer se establece true en, Atlas Kubernetes Operator pospone el mantenimiento programado cada vez que se aplican cambios al AtlasProject recurso personalizado. Si se spec.maintenanceWindow.defer establece true en, se debe cambiar spec.maintenanceWindow.defer a false después de aplicar los cambios.

spec.maintenanceWindow.dayOfWeek

Tipo: número

Condicional

Entero de base 1 que representa el día de la semana en que comienza la ventana de mantenimiento. Utilice la siguiente tabla para encontrar el entero correspondiente a cada día:

Día de la semana	entero
Domingo	1
Lunes	2
Martes	3
Miércoles	4
Jueves	5
Viernes	6
Sábado	7

Si desea configurar la ventana de mantenimiento para su proyecto, debe especificar esta configuración.

spec.maintenanceWindow.hourOfDay

Tipo: número

Condicional

Entero de base cero que representa la hora del día en que comienza la ventana de mantenimiento según un reloj de 24horas. Use 0 para medianoche y 12 para mediodía. Si desea configurar la ventana de mantenimiento para su proyecto, debe especificar esta opción.

spec.maintenanceWindow.startASAP

Tipo: booleano

Condicional

Bandera que indica si Atlas debería comenzar inmediatamente con el mantenimiento. spec.maintenanceWindow.defer y spec.maintenanceWindow.startASAP no pueden establecerse en true al mismo tiempo.

Importante

Si spec.maintenanceWindow.startASAP se establece true en, Atlas Kubernetes Operator inicia el mantenimiento cada vez que se aplican cambios al AtlasProject recurso personalizado. Si se spec.maintenanceWindow.startASAP establece true en, se debe cambiar spec.maintenanceWindow.startASAP a false después de aplicar los cambios.

spec.networkPeers

Tipo: arreglo

Opcional

Lista que contiene las configuraciones de peering de red para el proyecto.

spec.regionUsageRestrictions

Tipo: string

Opcional

Designa la región de AWS del proyecto solo para Atlas for Government. Puede especificar uno de los siguientes valores:

NONESi se establece regionUsageRestrictions en NONE, el valor predeterminado es COMMERCIAL_FEDRAMP_REGIONS_ONLY. Este es el valor predeterminado si se omite regionUsageRestrictions.
GOV_REGIONS_ONLY: Indica que el proyecto está restringido a las regiones de AWS GovCloud que cumplen con los requisitos de seguridad más estrictos del gobierno de EE. UU. Para obtener más información, consulte la documentación de AWS GovCloud.
COMMERCIAL_FEDRAMP_REGIONS_ONLY:Indica que el proyecto está restringido a las regiones estándar moderadas de AWS FedRamp.

spec.projectIpAccessList

Tipo: arreglo

Requerido

Lista de acceso IP que otorga acceso de red a los clústeres Atlas del proyecto. Puede especificar los siguientes parámetros del cuerpo:

Parameter	Tipo	Necesidad	Descripción
Grupo de seguridad de AWS	string	Condicional	Identificador único del grupo de seguridad de AWS que se agregará a la lista de acceso. Su entrada de lista de acceso puede incluir solo un awsSecurityGroup, un cidrBlock o una ipAddress. Debe configurar el emparejamiento de VPC para su proyecto antes de poder agregar un grupo de seguridad de AWS a una lista de acceso.
bloque cidr	string	Condicional	Rango de direcciones IP en notación CIDR que se agregarán a la lista de acceso. Su entrada de lista de acceso puede incluir solo un awsSecurityGroup, un cidrBlock o una ipAddress.
comment	string	Opcional	Comentario asociado a la entrada de la lista de acceso.
eliminarDespuésDeFecha	fecha	Opcional	Marca de tiempo en formato ISO,8601 fecha y hora UTC, tras la cual Atlas elimina la entrada de la lista de acceso. La fecha especificada debe ser posterior y estar dentro de una semana desde la fecha de la solicitud de API. IMPORTANTE: No se pueden configurar grupos de seguridad de AWS como entradas de lista de acceso temporales. Puede incluir un designador de 8601 zona horaria ISO para garantizar que la fecha de vencimiento se produzca con respecto a la hora local en la zona horaria especificada.
dirección IP	string	Condicional	Dirección IP única que se añadirá a la lista de acceso. Mutuamente excluyente con awsSecurityGroup y cidrBlock. Su entrada de lista de acceso puede incluir solo un awsSecurityGroup, un cidrBlock o una ipAddress.

spec.settings

Tipo: objeto

Opcional

Lista que contiene la configuración de tu proyecto.

spec.settings.isCollectDatabaseSpecificsStatisticsEnabled

Tipo: booleano

Opcional

Bandera que indica si su proyecto tiene habilitada la recopilación de estadísticas de base de datos en métricas de clúster.

spec.settings.isDataExplorerEnabled

Tipo: booleano

Opcional

Bandera que indica si su proyecto tiene el explorador de datos habilitado.

spec.settings.isExtendedStorageSizesEnabled

Tipo: booleano

Opcional

Indicador que indica si se deben habilitar tamaños de almacenamiento extendidos para el proyecto especificado. Para obtener más información sobre cómo habilitar el almacenamiento extendido, consulte Administrar la configuración del proyecto.

spec.settings.isPerformanceAdvisorEnabled

Tipo: booleano

Opcional

Bandera que indica si su proyecto tiene habilitado Performance Advisor.

spec.settings.isRealtimePerformancePanelEnabled

Tipo: booleano

Opcional

Bandera que indica si su proyecto tiene habilitado el Panel de rendimiento en tiempo real.

spec.settings.isSchemaAdvisorEnabled

Tipo: booleano

Opcional

Bandera que indica si su proyecto tiene habilitado el Asesor de esquemas.

spec.privateEndpoints

Tipo: arreglo

Opcional

Lista que contiene las configuraciones de puntos finales privados para el proyecto.

spec.teams

Tipo: objeto

Opcional

Objeto que contiene las especificaciones de tu equipo. Para obtener más información, consulta Configurar equipos.

spec.teams.teamRef.name

Tipo: string

Condicional

Etiqueta legible del recurso personalizado en AtlasTeam el metadata.name campo. Si desea asignar un equipo a este proyecto, debe especificar esta configuración.

spec.teams.teamRef.namespace

Tipo: string

Condicional

Espacio AtlasTeam de default nombres especificado en el recurso personalizado si es distinto de.

spec.teams.teamRef.roles

Tipo: string

Condicional

Roles de usuario de Atlas que un equipo utiliza para este proyecto. Si desea asignar un equipo a este proyecto, debe especificar esta configuración.

spec.withDefaultAlertsSettings

Tipo: booleano

Opcional

Por defecto: true

Indicador que indica si Atlas Kubernetes Operator crea un proyecto con las configuraciones de alerta predeterminadas. Si se omite, el valor predeterminado true es.

Si usa esta configuración, también debe establecer spec.alertConfigurationSyncEnabled en true para que Atlas Kubernetes Operator modifique las configuraciones de alerta del proyecto.

Si establece este parámetro en false al crear un proyecto, Atlas no agrega las configuraciones de alerta predeterminadas a su proyecto.

Esta configuración no tiene efecto en los proyectos existentes.

Para obtener información sobre cómo esta configuración interactúa con,spec.alertConfigurationSyncEnabled consulte Consideraciones.

spec.x509CertRef.name

Tipo: string

Opcional

Nombre del kubernetes.io/tls secreto para el certificado X..509

El operador Atlas Kubernetes solo observa secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar observar secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

Volver

Recursos personalizados

Implementación de Atlas