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
AtlasProjectRecurso 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.0De 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 personalizadoAtlasDeployment, 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:
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 campostatus.idcon el ID del proyecto.
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:
Una lista de acceso IP con el parámetro
spec.projectIpAccessList. Esta lista de acceso IP otorga acceso de red a los clústeres de Atlas en el proyecto.Equipos con el parámetro
spec.teams. Un equipo permite otorgar un rol de acceso a todo un grupo de usuarios de Atlas para un proyecto en particular.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.maintenanceWindowdatos.
Emparejamiento de red con el parámetro
spec.networkPeers. Emparejamiento de red permite conectar de forma segura a tu AWS, Azure o Google Cloud VPC.Cifrado en reposo usando claves gestionadas por el cliente con el parámetro
spec.encryptionAtRest. El cifrado en reposo usando claves gestionadas por el cliente te permite agregar una capa adicional de seguridad utilizando el KMS de tu proveedor de nube junto con el motor de almacenamiento cifradode MongoDB.Nodos privados con el parámetro
spec.privateEndpoints.Autenticación X.509 con el parámetro
spec.x509CertRef.name.Configuración del proyecto con el parámetro
spec.settings, incluyendo configuraciones para habilitar y deshabilitar lo siguiente:Recopilación de estadísticas de la base de datos en métricas del clúster
Configuraciones de alertas de proyecto con los parámetros
spec.alertConfigurationSyncEnabledyspec.alertConfigurations.Para obtener información sobre cómo interactúan estos ajustes, consulte las consideraciones.
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.
Ejemplo
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"
Ejemplo de Prometheus
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.
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 periodo de mantenimiento
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
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é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
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 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
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 del recurso personalizado AtlasProject:
spec.nameTipo: 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.alertConfigurationsTipo: matriz de objetos
Opcional
Lista que contiene configuraciones de alerta para este proyecto.
Si usa esta configuración, también debe establecer
spec.alertConfigurationSyncEnabledentruepara 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.eventTypeNameTipo: 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.enabledTipo: booleano
Opcional
Por defecto:
falseIndicador que señala si esta configuración de alerta está habilitada. Si se omite, el valor por defecto es
false.
spec.alertConfigurations.matchersTipo: 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.eventTypeNameespecifica un evento para un host, un set de réplicas o un clúster.
spec.alertConfigurations.matchers.fieldNameTipo: 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_NAMEHOSTNAMEHOSTNAME_AND_PORTPORTREPLICA_SET_NAMESHARD_NAMETYPE_NAME
El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la
spec.alertConfigurations.matchersmatriz.
spec.alertConfigurations.matchers.operatorTipo: 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:
EQUALSCONTAINSSTARTS_WITHENDS_WITHNOT_EQUALSNOT_CONTAINSREGEX
El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la
spec.alertConfigurations.matchersmatriz.
spec.alertConfigurations.matchers.valueTipo: string
Condicional
El operador Atlas Kubernetes requiere esta configuración si incluye un objeto en la
spec.alertConfigurations.matchersmatriz.
spec.alertConfigurations.metricThresholdTipo: objeto
Condicional
Umbral para la métrica que, cuando se supera, activa una alerta.
Atlas Kubernetes Operator requiere este ajuste cuando
spec.alertConfigurations.eventTypeNameestáOUTSIDE_METRIC_THRESHOLD.
spec.alertConfigurations.metricThreshold.metricNameTipo: string
Condicional
Etiqueta legible por humanos que identifica la métrica contra la cual Atlas verifica el
spec.alertConfigurations.metricThreshold.threshold.configuradoPara 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.modeTipo: string
Opcional
Por defecto:
AVERAGEAtlas calcula el valor métrico actual como un promedio.
El operador Atlas Kubernetes solo acepta un valor de
AVERAGE.
spec.alertConfigurations.metricThreshold.operatorTipo: 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_THANLESS_THAN
Atlas Kubernetes Operator requiere esta configuración si incluye el objeto
spec.alertConfigurations.metricThreshold.
spec.alertConfigurations.metricThreshold.thresholdTipo: 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.unitsTipo: 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:
BITSBYTESDAYSGIGABITSGIGABYTESHOURSKILOBITSKILOBYTESMEGABITSMEGABYTESMILLISECONDSMINUTESPETABYTESRAWSECONDSTERABYTES
Atlas Kubernetes Operator requiere esta configuración si incluye el objeto
spec.alertConfigurations.metricThreshold.
spec.alertConfigurations.notificationsTipo: arreglo
Condicional
Lista que describe las notificaciones que Atlas envía para las alertas que esta configuración de alerta describe.
Tipo: string
Condicional
Nombre del secreto opaco que contiene un solo campo
passwordcon el token de API de Slack.El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta
atlas.mongodb.com/type=credentialspara 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.namespaceTipo: 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.channelNameTipo: 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.typeNameaSLACK.
spec.alertConfigurations.notifications.datadogApiKeyRef.nameTipo: string
Condicional
Nombre del secreto opaco que contiene un solo campo
passwordcon 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=credentialspara 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.namespaceTipo: 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.datadogRegionTipo: string
Opcional
Por defecto:
USLa región de Datadog que indica qué URL de recursos uniformes de API utilizar.
Atlas Kubernetes Operator acepta los siguientes valores:
USEU
spec.alertConfigurations.notifications.delayMinsTipo: entero
Opcional
Por defecto:
0Nú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.emailAddressTipo: 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.typeNameaEMAIL.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.typeNamevalores:GROUPORGTEAMUSERS
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.emailEnabledTipo: 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.typeNameen uno de los siguientes valores:GROUPORGTEAM
spec.alertConfigurations.notifications.intervalMinTipo: 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.microsoftTeamsWebhookUrlTipo: 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.typeNameaMICROSOFT_TEAMS.
spec.alertConfigurations.notifications.mobileNumberTipo: 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.typeNameaSMS.
spec.alertConfigurations.notifications.opsGenieApiKeyRef.nameTipo: string
Condicional
Nombre del secreto opaco que contiene un único
passwordcampo 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=credentialspara 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.namespaceTipo: 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.opsGenieRegionTipo: string
Opcional
Por defecto:
USRegión de Opsgenie que indica qué localizador uniforme de recursos (URL) API utilizar.
Atlas Kubernetes Operator acepta los siguientes valores:
USEU
Atlas Kubernetes Operator aplica esta configuración si se configura
spec.alertConfigurations.notifications.typeNameaOPS_GENIE.
spec.alertConfigurations.notifications.rolesTipo: 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_MANAGERGROUP_DATA_ACCESS_ADMINGROUP_DATA_ACCESS_READ_ONLYGROUP_DATA_ACCESS_READ_WRITEGROUP_OWNERGROUP_READ_WRITEORG_OWNERORG_MEMBERORG_GROUP_CREATORORG_BILLING_ADMINORG_READ_ONLY
El operador de Kubernetes de Atlas aplica esta configuración cuando defines
spec.alertConfigurations.notifications.typeNameen uno de los siguientes valores:GROUPORG
spec.alertConfigurations.notifications.serviceKeyRef.nameTipo: string
Condicional
Nombre del secreto opaco que contiene un solo campo
passwordcon 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=credentialspara 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.namespaceTipo: 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.severityTipo: string
Opcional
Nivel de gravedad asignado a esta notificación.
Atlas Kubernetes Operator acepta los siguientes valores:
CRITICALERRORWARNING
spec.alertConfigurations.notifications.smsEnabledTipo: 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.typeNameen uno de los siguientes valores:GROUPORGTEAM
spec.alertConfigurations.notifications.teamIdTipo: 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.typeNameaTEAM.
spec.alertConfigurations.notifications.teamNameTipo: string
Condicional
Nombre del equipo Atlas que recibe esta notificación.
Atlas Kubernetes Operator requiere esta configuración si defines
spec.alertConfigurations.notifications.typeNameaTEAM.
spec.alertConfigurations.notifications.typeNameTipo: 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:DATADOGEMAILOPS-GENIEORGPAGER_DUTYPROMETHEUSSLACKSMSTEAMUSERVICTOR_OPSWEBHOOK
spec.alertConfigurations.notifications.usernameTipo: 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.typeNameaUSER.
spec.alertConfigurations.notifications.victorOpsSecretRef.nameTipo: string
Condicional
Nombre del opaco secreto que contiene un solo campo
passwordcon 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=credentialspara 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.namespaceTipo: 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.victorOpsRoutingKeyTipo: 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.typeNameaVICTOR_OPS.
spec.alertConfigurations.notifications.webhookSecretTipo: 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.typeNameaWEBHOOK.
spec.alertConfigurations.notifications.webhookUrlTipo: string
Condicional
String que indica la URL de tu webhook.
Atlas Kubernetes Operator requiere esta configuración si defines
spec.alertConfigurations.notifications.typeNameaWEBHOOK.
spec.alertConfigurations.severityOverrideTipo: string
Condicional
Reemplaza el nivel de gravedad por defecto asignado por Atlas para un Proyecto alerta.
Atlas Kubernetes Operator acepta los siguientes valores:
CRITICALERRORWARNINGINFO
spec.alertConfigurations.thresholdTipo: 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.eventTypeNamedistintoOUTSIDE_METRIC_THRESHOLDde.
spec.alertConfigurations.threshold.operatorTipo: 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_THANLESS_THAN
Atlas Kubernetes Operator requiere esta configuración si incluye el objeto
spec.alertConfigurations.threshold.
spec.alertConfigurations.threshold.thresholdTipo: 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.unitsTipo: 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:
BITSBYTESDAYSGIGABITSGIGABYTESHOURSKILOBITSKILOBYTESMEGABITSMEGABYTESMILLISECONDSMINUTESPETABYTESRAWSECONDSTERABYTES
Atlas Kubernetes Operator requiere esta configuración si incluye el objeto
spec.alertConfigurations.threshold.
spec.alertConfigurationSyncEnabledTipo: booleano
Opcional
Por defecto:
falseMarca 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 enfalse, Atlas Kubernetes Operator no sincronizará las configuraciones de alertas del proyecto con las que definas en el recurso personalizadoAtlasProject.Para obtener información sobre cómo esta configuración está en interacción con
spec.withDefaultAlertsSettings, consulte las Consideraciones.
spec.auditing.auditAuthorizationSuccessTipo: booleano
Opcional
Por defecto:
falseMarca 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ámetrotrueen, debespec.auditing.enabledestablecertrueen. 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.auditFilterTipo: 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.enabledentrue.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.enabledTipo: booleano
Condicional
Por defecto:
falseIndicador que indica si se debe habilitar la auditoría para el Proyecto. Para especificar un valor para
spec.auditing.auditFilter, o para establecerspec.auditing.auditAuthorizationSuccessentrue, debes especificar esta configuración. Para obtener más información, consulta Habilitar registros de auditoría.
spec.backupCompliancePolicyRefTipo: objeto
Condicional
Objeto que contiene el nombre y namespace del secreto opaco que hace referencia al
AtlasBackupCompliancePolicyrecurso personalizado. Si activas una Política de cumplimiento de copias de seguridad, debes especificar este parámetro.
spec.backupCompliancePolicyRef.nameTipo: string
Condicional
Nombre del secreto opaco que hace referencia al
AtlasBackupCompliancePolicyCustom Resource. Si habilita una política de cumplimiento de copia de seguridad, debe especificar este parámetro.
spec.backupCompliancePolicyRef.namespaceTipo: objeto
Condicional
Espacio de nombres del secreto opaco que hace referencia al
AtlasBackupCompliancePolicyrecurso personalizado. Si habilita una política de cumplimiento de copias de seguridad, debe especificar este parámetro.
spec.connectionSecretRef.nameTipo: string
Opcional
Nombre del secreto opaco que contiene un único
passwordcampo 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 elglobalsecreto predeterminado.El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta
atlas.mongodb.com/type=credentialspara 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
AtlasProjectRecurso personalizado. Para almacenar secretos en otro namespace, especifica el parámetrospec.connectionSecretRef.namespace.
spec.connectionSecretRef.namespaceTipo: 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
AtlasProjectrecurso personalizado.
spec.cloudProviderAccessRolesTipo: arreglo
Obsoleto. Utiliza
spec.cloudProviderIntegrationsen su lugar.Lista que contiene su configuración de acceso unificado al proveedor de la nube.
spec.cloudProviderAccessRoles.iamAssumedRoleArnTipo: string
Obsoleto. Utiliza
spec.cloudProviderIntegrations.iamAssumedRoleArnen 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.providerNameTipo: string
Obsoleto. Utiliza
spec.cloudProviderIntegrations.providerNameen su lugar.Proveedor de nube para el rol de acceso que asume Atlas. Atlas Kubernetes Operator admite
AWSpara el acceso unificado al proveedor de nube. Si quieres configurar el acceso unificado del proveedor de nube, debes especificar esta configuración.
spec.cloudProviderIntegrationsTipo: arreglo
Opcional
Lista que contiene la configuración de integración de su proveedor de nube unificado.
spec.cloudProviderIntegrations.iamAssumedRoleArnTipo: 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.providerNameTipo: string
Condicional
Proveedor de nube para el rol de acceso que asume Atlas. El operador de Kubernetes de Atlas admite
AWSpara integraciones unificadas con proveedores de nube. Si desea configurar integraciones unificadas con proveedores de nube, debe especificar esta configuración.
spec.customRolesTipo: 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.encryptionAtRestTipo: arreglo
Opcional
Lista que contiene las configuraciones para el cifrado en reposo usando llaves gestionadas por el cliente para el proyecto.
spec.encryptionAtRest.awsKmsTipo: 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.enabledTipo: 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 afalse. Si deshabilitas el cifrado en reposo usando AWS KMS, Atlas Kubernetes Operator elimina los detalles de la configuración.
spec.encryptionAtRest.awsKms.regionTipo: string
Opcional
Etiqueta que indica la región de AWS donde existe la llave maestra de cliente.
spec.encryptionAtRest.awsKms.secretRef.nameTipo: 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=credentialspara 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.namespaceTipo: string
Opcional
Espacio de nombres que contiene sus credenciales de AWS. Si no se especifica, este parámetro toma como valor predeterminado el
AtlasProjectespacio de nombres del recurso personalizado.
spec.encryptionAtRest.azureKeyVaultTipo: 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.azureEnvironmentTipo: 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_CHINAyAZURE_GERMANY.
spec.encryptionAtRest.azureKeyVault.clientIDTipo: string
Opcional
string de 36 caracteres hexadecimales única que identifica su aplicación de Azure .
spec.encryptionAtRest.azureKeyVault.enabledTipo: 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.resourceGroupNameTipo: 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.nameTipo: 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=credentialspara 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.namespaceTipo: string
Opcional
Espacio de nombres que contiene sus credenciales de Azure. Si no se especifica, este parámetro toma como valor predeterminado el
AtlasProjectespacio de nombres del recurso personalizado.
spec.encryptionAtRest.azureKeyVault.tenantIDTipo: 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.googleCloudKmsTipo: 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 enfalse. Si inhabilita el cifrado en reposo usando Google Cloud KMS, Atlas Kubernetes Operator removerá los detalles de configuración.
spec.encryptionAtRest.googleCloudKms.secretRef.nameTipo: 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=credentialspara 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.namespaceTipo: 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.integrationsTipo: 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.maintenanceWindowTipo: objeto
Opcional
Lista que contiene la configuración del periodo de mantenimiento. Puede especificar los siguientes parámetros corporales:
NombreTipoNecesidadDescripcióndí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 semanaenterodomingo
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.autoDeferTipo: 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.deferTipo: booleano
Condicional
Bandera que indica si Atlas debe posponer el mantenimiento programado. Debes programar el mantenimiento antes de poder posponerlo satisfactoriamente.
spec.maintenanceWindow.deferyspec.maintenanceWindow.startASAPno pueden ser ambos configurados entrueal mismo tiempo.Importante
Mientras que
spec.maintenanceWindow.deferesté configurado entrue, Atlas Kubernetes Operator pospone el mantenimiento programado cada vez que aplicas cambios al recurso personalizadoAtlasProject. Si establecespec.maintenanceWindow.deferentrue, deberá cambiarspec.maintenanceWindow.deferafalsedespués de aplicar los cambios.
spec.maintenanceWindow.dayOfWeekTipo: 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 semanaenterodomingo
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.hourOfDayTipo: 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
0para medianoche y12para el mediodía. Si deseas configurar el periodo de mantenimiento para tu Proyecto, debes especificar esta configuración.
spec.maintenanceWindow.startASAPTipo: booleano
Condicional
Bandera que indica si Atlas debería comenzar inmediatamente con el mantenimiento.
spec.maintenanceWindow.deferyspec.maintenanceWindow.startASAPno pueden establecerse entrueal mismo tiempo.Importante
Mientras que
spec.maintenanceWindow.startASAPestá configurado entrue, Atlas Kubernetes Operator inicia el mantenimiento cada vez que se aplican cambios al recurso personalizadoAtlasProject. Si configuraspec.maintenanceWindow.startASAPentrue, debe cambiarspec.maintenanceWindow.startASAPafalsedespués de aplicar los cambios.
spec.networkPeersTipo: arreglo
Opcional
Obsoleto
Importante
Este parámetro está obsoleto a partir del operador de Atlas Kubernetes.
2.8Migre 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.regionUsageRestrictionsTipo: 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.projectIpAccessListTipo: arreglo
Requerido
Obsoleto
Importante
Este parámetro está obsoleto a partir del operador de Atlas Kubernetes.
2.7Migre 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:
ParameterTipoNecesidadDescripciónawsSecurityGroup
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.isCollectDatabaseSpecificsStatisticsEnabledTipo: 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.isDataExplorerEnabledTipo: booleano
Opcional
Bandera que indica si el proyecto tiene habilitado el explorador de datos.
spec.settings.isExtendedStorageSizesEnabledTipo: 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.isPerformanceAdvisorEnabledTipo: booleano
Opcional
Indicador que señala si tu proyecto tiene Performance Advisor habilitado.
spec.settings.isRealtimePerformancePanelEnabledTipo: booleano
Opcional
Bandera que indica si su proyecto tiene habilitado el Panel de rendimiento en tiempo real.
spec.settings.isSchemaAdvisorEnabledTipo: booleano
Opcional
Bandera que indica si tu proyecto tiene Schema Advisor activado.
spec.privateEndpointsTipo: 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.teamsTipo: objeto
Opcional
Objeto que contiene las especificaciones de tu equipo. Para obtener más información, consulta Configurar equipos.
spec.teams.teamRef.nameTipo: string
Condicional
Etiqueta legible del recurso personalizado en
AtlasTeamelmetadata.namecampo. Si desea asignar un equipo a este proyecto, debe especificar esta configuración.
spec.teams.teamRef.namespaceTipo: string
Condicional
Namespace especificado en el
AtlasTeamRecurso Personalizado si es diferente dedefault.
spec.teams.teamRef.rolesTipo: 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.withDefaultAlertsSettingsTipo: booleano
Opcional
Por defecto:
trueIndicador 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.alertConfigurationSyncEnabledentruepara que Atlas Kubernetes Operator modifique las configuraciones de alerta del proyecto.Si se establece este parámetro en
falseal 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.nameTipo: string
Opcional
Nombre del secreto de
kubernetes.io/tlspara el certificado X.509.El Atlas Kubernetes Operator supervisa los secretos solo con la etiqueta
atlas.mongodb.com/type=credentialspara evitar la supervisión de secretos innecesarios.El siguiente ejemplo etiqueta un secreto:
kubectl label secret the-user-password atlas.mongodb.com/type=credentials