Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
/ / /

AtlasProject Recurso personalizado

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

Recursos personalizados ya no borran objetos por defecto

  • El operador de Kubernetes de Atlas utiliza Archivos de configuraciónde recursos personalizados para administrar la configuración de Atlas. Sin embargo, a partir del Operador 2.0 de 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 administrarlos en Atlas. Por ejemplo, si elimina un AtlasProject Recurso personalizado en Kubernetes. De forma predeterminada, el operador de Kubernetes de Atlas ya no elimina automáticamente el proyecto correspondiente de Atlas. Este cambio de comportamiento ayuda a evitar eliminaciones accidentales o inesperadas. Para obtener más información, incluido cómo revertir este comportamiento al predeterminado anterior al operador de Kubernetes de 2.0 Atlas, consulte Nuevo valor predeterminado: Protección contra eliminaciones en el operador de Kubernetes de 2 Atlas.0

    De manera similar, Atlas Kubernetes Operator no elimina equipos de Atlas si los elimina de un proyecto Atlas en Kubernetes con Atlas Kubernetes Operator.

  • Define explícitamente los detalles de configuración que deseas para evitar el uso implícito de los valores de configuración por defecto de Atlas. En algunos casos, heredar los valores por defecto de Atlas puede crear un ciclo de conciliación que impida que el recurso personalizado alcance un estado de READY. Por ejemplo, definir explícitamente el comportamiento de escalado automático deseado en el recurso personalizado AtlasDeployment, como se muestra en el ejemplo incluido, garantiza que un tamaño de instancia estático en el recurso personalizado no se aplique repetidamente a una implementación de Atlas que tiene 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:

Puedes utilizar el parámetro spec.connectionSecretRef.name para establecer el secreto de la conexión para el recurso personalizado AtlasProject. Este parámetro reemplaza la conexión global por defecto secreta.

Por defecto, Atlas Kubernetes Operator mantiene los secretos de conexión en el mismo namespace que el AtlasProject Recurso personalizado. Para almacenar secretos en otro namespace, especifica el parámetro spec.connectionSecretRef.namespace.

Para conectarse a la API de Administración de Atlas, Atlas Kubernetes Operator lee el Identificador 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:

Si eliminas el recurso AtlasProject de tu clúster de Kubernetes, Atlas Kubernetes Operator elimina el proyecto de Atlas. Debes remover todos los clústeres del proyecto de antemano. De lo contrario, Atlas rechaza la solicitud de borrado.

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

El siguiente ejemplo muestra una especificación de recursos personalizada de 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, consulta Integración con servicios de terceros.

Nota

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

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.

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que establece el periodo de mantenimiento a las 5:00 AM todos los martes con aplazamiento automático desactivado:

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

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étricasde 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

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

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

Esta sección describe los parámetros del recurso personalizado AtlasProject:

spec.name

Tipo: string

Requerido

Nombre del proyecto creado o actualizado en Atlas. El nombre no debe exceder 64 caracteres. El nombre solo debe contener letras, números, espacios, guiones y guiones bajos. No se puede modificar después de la creación del proyecto.

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 señala si esta configuración de alerta está habilitada. Si se omite, el valor por defecto es false.

spec.alertConfigurations.matchers

Tipo: matriz de objetos

Condicional

Lista de reglas que determinan si Atlas verifica un objeto para la configuración de alertas. Puedes filtrar usando el arreglo de coincidencia si spec.alertConfigurations.eventTypeName especifica un evento para un host, un set de réplicas o un clúster.

spec.alertConfigurations.matchers.fieldName

Tipo: string

Condicional

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

Atlas Kubernetes Operator 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.

Atlas Kubernetes Operator 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.

Atlas Kubernetes Operator requiere este ajuste cuando spec.alertConfigurations.eventTypeName está OUTSIDE_METRIC_THRESHOLD.

spec.alertConfigurations.metricThreshold.metricName

Tipo: string

Condicional

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

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.

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

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 actual de la métrica.

Atlas Kubernetes Operator acepta los siguientes valores:

  • GREATER_THAN

  • LESS_THAN

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

spec.alertConfigurations.metricThreshold.threshold

Tipo: entero

Condicional

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

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

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.

Atlas Kubernetes Operator acepta los siguientes valores:

  • BITS

  • BYTES

  • DAYS

  • GIGABITS

  • GIGABYTES

  • HOURS

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • MILLISECONDS

  • MINUTES

  • PETABYTES

  • RAW

  • SECONDS

  • TERABYTES

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

spec.alertConfigurations.notifications

Tipo: arreglo

Condicional

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

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 Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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.

Atlas Kubernetes Operator requiere esta configuración cuando estableces spec.alertConfigurations.notifications.typeName a SLACK.

spec.alertConfigurations.notifications.datadogApiKeyRef.name

Tipo: string

Condicional

Nombre del secreto opaco que contiene un solo campo password con la clave de la API para Datadog. Si deseas recibir notificaciones a través de Datadog, debes especificar esta configuración`.

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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

namespace que contiene tu clave API de Datadog. Si deseas recibir notificaciones a través de Datadog, debes especificar esta configuración.

spec.alertConfigurations.notifications.datadogRegion

Tipo: string

Opcional

Por defecto: US

La región de Datadog que indica qué URL de recursos uniformes de API utilizar.

Atlas Kubernetes Operator 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.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a EMAIL.

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 Atlas user o a un grupo de usuarios, establece el parámetro spec.alertConfigurations.notifications.emailEnabled.

spec.alertConfigurations.notifications.emailEnabled

Tipo: booleano

Condicional

Indicador que señala si Atlas envía notificaciones por correo electrónico.

El Operador de Kubernetes Atlas requiere esta configuración cuando se establece spec.alertConfigurations.notifications.typeName en uno de los siguientes 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 usan este campo. Configure y gestione el intervalo de notificaciones dentro de cada uno de esos 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.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a MICROSOFT_TEAMS.

spec.alertConfigurations.notifications.mobileNumber

Tipo: string

Condicional

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

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a SMS.

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 Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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

Namespace que contiene tu clave de API para Opsgenie. Si deseas recibir notificaciones a través de Opsgenie, debes 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.

Atlas Kubernetes Operator acepta los siguientes valores:

  • US

  • EU

Atlas Kubernetes Operator aplica esta configuración si se configura spec.alertConfigurations.notifications.typeName a OPS_GENIE.

spec.alertConfigurations.notifications.roles

Tipo: arreglo

Opcional

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

Atlas Kubernetes Operator 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 solo campo password con la clave API para PagerDuty. Si quieres notificaciones a través de PagerDuty, debes especificar esta configuración.

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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

Nivel de gravedad asignado a esta notificación.

Atlas Kubernetes Operator 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 de Kubernetes Atlas requiere esta configuración cuando se establece spec.alertConfigurations.notifications.typeName en uno de los siguientes valores:

  • GROUP

  • ORG

  • TEAM

spec.alertConfigurations.notifications.teamId

Tipo: string

Condicional

Unique 24-hexadecimal digit string que identifica a un equipo de Atlas.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a TEAM.

spec.alertConfigurations.notifications.teamName

Tipo: string

Condicional

Nombre del equipo Atlas que recibe esta notificación.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a TEAM.

spec.alertConfigurations.notifications.typeName

Tipo: string

Condicional

etiqueta legible por humanos que muestra el tipo de notificación de alerta. Esta configuración es obligatoria si especifica un valor para la configuración spec.alertConfigurations.notifications. Atlas admite los siguientes 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 del usuario al que Atlas envía notificaciones. Especificar solo usuarios de Atlas que pertenezcan al proyecto que sea propietario de la configuración de alertas.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a USER.

spec.alertConfigurations.notifications.victorOpsSecretRef.name

Tipo: string

Condicional

Nombre del opaco secreto que contiene un solo campo password con la clave de API para Splunk On-Call. Si deseas notificaciones a través de Splunk On-Call, debes especificar esta configuración.

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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

Namespace que contiene su clave API para Splunk On-Call. Si deseas notificaciones a través de Splunk On-Call, debes 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.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a VICTOR_OPS.

spec.alertConfigurations.notifications.webhookSecret

Tipo: string

Opcional

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

Atlas Kubernetes Operator aplica esta configuración si se configura spec.alertConfigurations.notifications.typeName a WEBHOOK.

spec.alertConfigurations.notifications.webhookUrl

Tipo: string

Condicional

String que indica la URL de tu webhook.

Atlas Kubernetes Operator requiere esta configuración si defines spec.alertConfigurations.notifications.typeName a WEBHOOK.

spec.alertConfigurations.severityOverride

Tipo: string

Condicional

Reemplaza el nivel de gravedad por defecto asignado por Atlas para un Proyecto alerta.

Atlas Kubernetes Operator acepta los siguientes valores:

  • CRITICAL

  • ERROR

  • WARNING

  • INFO

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 a aplicar cuando Atlas verifica el valor actual de la métrica.

Atlas Kubernetes Operator acepta los siguientes valores:

  • GREATER_THAN

  • LESS_THAN

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

spec.alertConfigurations.threshold.threshold

Tipo: entero

Condicional

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

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

spec.alertConfigurations.threshold.units

Tipo: string

Condicional

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

Atlas Kubernetes Operator acepta los siguientes valores:

  • BITS

  • BYTES

  • DAYS

  • GIGABITS

  • GIGABYTES

  • HOURS

  • KILOBITS

  • KILOBYTES

  • MEGABITS

  • MEGABYTES

  • MILLISECONDS

  • MINUTES

  • PETABYTES

  • RAW

  • SECONDS

  • TERABYTES

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

spec.alertConfigurationSyncEnabled

Tipo: booleano

Opcional

Por defecto: false

Marca que indica si Atlas Kubernetes Operator aplica la configuración de alertas del proyecto definida en spec.alertConfigurations. Si omites o estableces este parámetro en false, Atlas Kubernetes Operator no sincronizará las configuraciones de alertas del proyecto con las que definas en el recurso personalizado AtlasProject.

Para obtener información sobre cómo esta configuración está en interacción con spec.withDefaultAlertsSettings, consulte las 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 debas escapar la JSON string para remover caracteres que impidan el análisis, como las comillas simples o dobles. Para especificar un valor para esta configuración, debes establecer spec.auditing.enabled en true.

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 para el Proyecto. Para especificar un valor para spec.auditing.auditFilter, o para establecer spec.auditing.auditAuthorizationSuccess en true, debes especificar esta configuración. Para obtener más información, consulta 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 Custom Resource. Si habilita una política de cumplimiento de copia 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 Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

Por defecto, Atlas Kubernetes Operator mantiene los secretos de conexión en el mismo namespace que el AtlasProject Recurso personalizado. Para almacenar secretos en otro namespace, especifica el parámetro spec.connectionSecretRef.namespace.

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 su configuración de acceso unificado al proveedor de la nube.

spec.cloudProviderAccessRoles.iamAssumedRoleArn

Tipo: string

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

AWS ARN único que identifica el rol de acceso IAM que Atlas asume. Si deseas configurar acceso unificado de proveedor de nube, debes especificar este ajuste.

spec.cloudProviderAccessRoles.providerName

Tipo: string

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

Proveedor de nube para el rol de acceso que asume Atlas. Atlas Kubernetes Operator admite AWS para el acceso unificado al proveedor de nube. Si quieres configurar el acceso unificado del proveedor de nube, debes 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

Obsoleto

Importante

Este parámetro está obsoleto a partir de Atlas Kubernetes Operator 2.6. Migra al Recurso personalizado AtlasPrivateEndpoint de acuerdo con la guía de migración.

Objeto que contiene tus especificaciones de roles personalizados.

spec.encryptionAtRest

Tipo: arreglo

Opcional

Lista que contiene las configuraciones para el cifrado en reposo usando llaves gestionadas por el cliente para el proyecto.

spec.encryptionAtRest.awsKms

Tipo: objeto

Opcional

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

spec.encryptionAtRest.enabled

Tipo: booleano

Opcional

Indicador que señala si este proyecto utiliza AWS KMS para cifrar datos en reposo. Para habilitar el cifrado en reposo utilizando AWS KMS, establece este parámetro en true. Para desactivar el cifrado en reposo usando AWS KMS, ajusta este parámetro a false. Si deshabilitas el cifrado en reposo usando AWS KMS, Atlas Kubernetes Operator elimina los detalles de la configuración.

spec.encryptionAtRest.awsKms.region

Tipo: string

Opcional

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

spec.encryptionAtRest.awsKms.secretRef.name

Tipo: string

Opcional

Nombre del secreto opaco secreto que contiene tus credenciales de AWS.

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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 utilizar Azure Key Vault para el cifrado en reposo utilizando claves administradas por el cliente para el proyecto.

spec.encryptionAtRest.azureKeyVault.azureEnvironment

Tipo: string

Opcional

Ubicación de implementación de Azure donde se encuentran las credenciales de la cuenta de Azure. Los valores válidos incluyen AZURE, AZURE_CHINA y AZURE_GERMANY.

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 Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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 usando claves gestionadas por el cliente para el proyecto.

spec.encryptionAtRest.googleCloudKms.enabled`

Tipo: string

Opcional

Indicador que señala si este proyecto utiliza Google Cloud KMS para cifrar los datos en reposo. Para habilitar el cifrado en reposo utilizando Google Cloud KMS, establezca este parámetro en true. Para desactivar el cifrado en reposo usando Google Cloud KMS, establece este parámetro en false. Si inhabilita el cifrado en reposo usando Google Cloud KMS, Atlas Kubernetes Operator removerá los detalles de configuración.

spec.encryptionAtRest.googleCloudKms.secretRef.name

Tipo: string

Opcional

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

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de 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

Namespace que contiene tus credenciales de Google Cloud. Si no se especifica, este parámetro se asigna por defecto al namespace del recurso personalizado AtlasProject.

spec.integrations

Tipo: arreglo

Opcional

Obsoleto

Importante

Este parámetro se considera obsoleto a partir de Atlas Kubernetes Operator 2.9. Migre al recurso personalizado AtlasThirdPartyIntegration de acuerdo con la guía de migración.

Lista que contiene su configuración de integración de terceros.

spec.maintenanceWindow

Tipo: objeto

Opcional

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

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

hourOfDay

Número

Requerido

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

autoDeferOnceEnabled

booleano

Opcional

Bandera que indica si desea posponer todos los periodos de mantenimiento una semana desde que se activarían.

Importante

Consideraciones sobre el periodo de mantenimiento

actividades de mantenimiento urgentes
Las actividades de mantenimiento urgentes, como los parches de seguridad, no pueden esperar hasta que se elija la ventana correspondiente. Atlas iniciará esas actividades de mantenimiento 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 de clúster en curso o problemas inesperados del sistema podrían retrasar la hora de inicio.
spec.maintenanceWindow.autoDefer

Tipo: booleano

Condicional

Una bandera que indica si Atlas debería posponer todos los periodos de mantenimiento durante una semana después de habilitarlos.

spec.maintenanceWindow.defer

Tipo: booleano

Condicional

Bandera que indica si Atlas debe posponer el mantenimiento programado. Debes programar el mantenimiento antes de poder posponerlo satisfactoriamente. spec.maintenanceWindow.defer y spec.maintenanceWindow.startASAP no pueden ser ambos configurados en true al mismo tiempo.

Importante

Mientras que spec.maintenanceWindow.defer esté configurado en true, Atlas Kubernetes Operator pospone el mantenimiento programado cada vez que aplicas cambios al recurso personalizado AtlasProject. Si establece spec.maintenanceWindow.defer en true, deberá cambiar spec.maintenanceWindow.defer a false después de aplicar los cambios.

spec.maintenanceWindow.dayOfWeek

Tipo: número

Condicional

Entero basado en uno que representa el día de la semana en que comienza el periodo de mantenimiento. Utilice la siguiente tabla para encontrar el entero que corresponde 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 deseas configurar el periodo de mantenimiento para tu Proyecto, debes 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 el periodo de mantenimiento según un reloj de 24 horas. Utiliza 0 para medianoche y 12 para el mediodía. Si deseas configurar el periodo de mantenimiento para tu Proyecto, debes especificar esta configuració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

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

spec.networkPeers

Tipo: arreglo

Opcional

Obsoleto

Importante

Este parámetro está obsoleto a partir del operador de Atlas Kubernetes.2.8 Migre a los recursos personalizados AtlasNetworkPeering y AtlasNetworkContainer según la guía de migración.

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

spec.regionUsageRestrictions

Tipo: string

Opcional

Designa la región del proyecto solo para Atlas para el Gobierno. Puede especificar uno de los siguientes valores:

  • NONE: El proyecto no tiene restricciones de uso por regiones. Este es el valor por defecto.

  • GOV_REGIONS_ONLY:Restringe el proyecto a las regiones de nube gubernamental que usted especifique.

  • COMMERCIAL_FEDRAMP_REGIONS_ONLY:Indica que el proyecto está restringido a las regiones estándar moderadas de AWS FedRamp.

spec.projectIpAccessList

Tipo: arreglo

Requerido

Obsoleto

Importante

Este parámetro está obsoleto a partir del operador de Atlas Kubernetes.2.7 Migre al recurso personalizado AtlasIPAccessList según la guía de migración.

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

Parameter
Tipo
Necesidad
Descripción

awsSecurityGroup

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 el proyecto antes de poder añadir un grupo de seguridad de AWS a una lista de acceso.

cidrBlock

string

Condicional

Rango de direcciones IP en notación CIDR que se añadirá 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.

deleteAfterDate

fecha

Opcional

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC después del cual Atlas remueve la entrada de la lista de acceso. La fecha especificada debe estar en el futuro y dentro de una semana desde el momento en que realices la solicitud de API.

IMPORTANTE: No se pueden establecer los grupos de seguridad de AWS como entradas temporales de la lista de acceso.

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 debe añadirse 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 el proyecto tiene habilitado el explorador de datos.

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

Indicador que señala si tu proyecto tiene Performance Advisor habilitado.

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 tu proyecto tiene Schema Advisor activado.

spec.privateEndpoints

Tipo: arreglo

Opcional

Obsoleto

Importante

Este parámetro está obsoleto a partir de Atlas Kubernetes Operator 2.6. Migra al Recurso personalizado AtlasPrivateEndpoint de acuerdo con la guía de migración.

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

Namespace especificado en el AtlasTeam Recurso Personalizado si es diferente de default.

spec.teams.teamRef.roles

Tipo: string

Condicional

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

spec.withDefaultAlertsSettings

Tipo: booleano

Opcional

Por defecto: true

Indicador que señala si Atlas Kubernetes Operator crea un Proyecto con las configuraciones de alerta por defecto. Si se omite, el valor por defecto es true.

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 se establece este parámetro en false al crear un proyecto, Atlas no añade las configuraciones de alertas por defecto al proyecto.

Esta configuración no afecta a los proyectos existentes.

Para obtener información sobre cómo esta configuración está en interacción con spec.alertConfigurationSyncEnabled, consulte las Consideraciones.

spec.x509CertRef.name

Tipo: string

Opcional

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

El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de secretos innecesarios.

El siguiente ejemplo etiqueta un secreto:

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

Volver

Recursos personalizados

En esta página