Docs Menu
Docs Home
/ /
Recursos personalizados
Docs Home
/
Gestión
/
Operador de Atlas Kubernetes
/
Recursos personalizados
Docs Home
/
Gestión
/
Operador de Atlas Kubernetes
/
Recursos personalizados

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

Los recursos personalizados ya no eliminan objetos de forma predeterminada

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

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

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

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

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

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

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

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

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

Ejemplo

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasProject:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 connectionSecretRef:
   name: my-atlas-key
 projectIpAccessList:
   - cidrBlock: "203.0.113.0/24"
     comment: "CIDR block for Application Server B - D"

Ejemplo de Prometheus

El siguiente ejemplo muestra una especificación de recurso personalizada AtlasProject que se integra con Prometheus:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: TestPrometheusIntegration
  connectionSecretRef:
    name: my-atlas-key
  projectIpAccessList:
    - cidrBlock: "0.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
    - cidrBlock: "128.0.0.0/1"
      comment: "Everyone has access. For test purposes only."
  integrations:
    - type: "PROMETHEUS"
      enabled: "true"
      username: "prometheus-user"
      passwordRef:
        name: "password-name"
        namespace: "password-namespace"
      scheme: "http"
      serviceDiscovery: "http"

Para obtener más información,consulte Integración con servicios de terceros.

Nota

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

Ejemplo de equipos

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que otorga al green-leaf-team el rol de Organization Owner para este proyecto. Los miembros del equipo están definidos en el recurso personalizado AtlasTeam.

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test project
  teams:
    - teamRef:
        name: green-leaf-team
      roles:
      - ORGANIZATION_OWNER

Para obtener más información, consulte Configurar equipos.

Ejemplo de ventana de mantenimiento

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

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
 name: my-project
spec:
 name: Test project
 projectIpAccessList:
   - ipAddress: "192.0.2.15"
     comment: "IP address for Application Server A"
maintenanceWindow:
 dayOfWeek: 3
 hourOfDay: 5
 autoDefer: false

Ejemplo de configuración del proyecto

El siguiente ejemplo muestra una AtlasProject especificación de recurso personalizado que deshabilita la recopilación de estadísticas de base de datos en las mé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 del registro de operaciones alcanza menos de una hora:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT",
      enabled: true,
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         typeName: "GROUP"
      threshold:
         operator: "LESS_THAN",
         threshold: "1",
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

Ejemplo de configuración de alertas de terceros

El siguiente ejemplo muestra una especificación de recurso personalizado AtlasProject que configura una alerta que envía notificaciones a través de Slack:

apiVersion: atlas.mongodb.com/v1
kind: AtlasProject
metadata:
  name: my-project
spec:
  name: Test Atlas Operator Project
  connectionSecretRef:
    name: my-atlas-key
  alertConfigurations:
    - eventTypeName: "REPLICATION_OPLOG_WINDOW_RUNNING_OUT"
      enabled: true
      notifications:
      -  delayMin: 0
         emailEnabled: true
         intervalMin: 60
         roles: [ "GROUP_OWNER" ]
         smsEnabled: false
         - typeName: "SLACK"
           apiTokenRef:
             name: key-name
             namespace: key-namespace
      threshold:
         operator: "LESS_THAN"
         threshold: "1"
         units: "HOURS"
  alertConfigurationSyncEnabled: true
  withDefaultAlertsSettings: false

Parámetros

Proyecto Atlas

AtlasProject es el esquema para la API de atlasprojects

Name
Tipo
Descripción
Requerido

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasProject

true

metadata

Objeto

Consulte la documentación de Kubernetes API para conocer los campos del campo metadata.

true

spec

Objeto

AtlasProjectSpec Define el estado objetivo del proyecto en Atlas

false

status

Objeto

AtlasProjectStatus define el estado observado de AtlasProject

false

AtlasProject.spec

AtlasProjectSpec define el estado objetivo del proyecto en Atlas

Name
Tipo
Descripción
Requerido

name

string

El nombre es el name del proyecto creado en Atlas por el operador si aún no existe. El name no debe exceder los 64 caracteres. El name solo debe contener letras, números, espacios, guiones y guiones bajos. Validaciones:

  • self == oldSelf: El nombre no se puede modificar después de la creación del proyecto

true

alertConfigurationSyncEnabled

booleano

AlertConfigurationSyncEnabled Es una bandera que habilita o deshabilita la sincronización de las configuraciones de alertas del proyecto actual. Si es verdadera, las configuraciones de alertas del proyecto se sincronizarán según AlertConfigurations. Si no es así, el operador no las modificará. Se pueden gestionar mediante API, CLI y UI.

false

alertConfigurations

[]objeto

AlertConfiguration Es una lista de las configuraciones de alertas configuradas para el proyecto actual. Si usa esta configuración, también debe establecer spec.``alertConfigurationSyncEnabled`` en `true` para que Atlas Kubernetes Operator pueda modificar las configuraciones de alertas del proyecto. Si omite esta configuración o la deja vacía, Atlas Kubernetes Operator no modifica las configuraciones de alertas del proyecto. Al crear un proyecto, Atlas aplica las configuraciones de alertas predeterminadas.

false

auditing

Objeto

La auditoría representa MongoDB ventanas de mantenimiento.

false

backupCompliancePolicyRef

Objeto

BackupCompliancePolicyRef es una referencia al recurso personalizado de cumplimiento de respaldo.

false

cloudProviderAccessRoles

[]objeto

CloudProviderAccessRoles es una lista de roles de acceso de proveedores de nube configurados para el proyecto actual. Obsoleto: Esta configuración quedó obsoleta en favor de CloudProviderIntegrations

false

cloudProviderIntegrations

[]objeto

CloudProviderIntegrations Es una lista de integraciones de proveedores de nube configuradas para el proyecto actual.

false

connectionSecretRef

Objeto

ConnectionSecret Es el nombre del secreto de Kubernetes que contiene la información sobre cómo conectarse a Atlas (claves de organización ID, API). Si no se proporciona, se utilizará la configuración de conexión predeterminada del operador.

false

customRoles

[]objeto

CustomRoles Permite crear y modificar roles personalizados en el clúster. Use roles personalizados para especificar conjuntos de acciones personalizados que los roles integrados de Atlas no pueden describir. Obsoleto: Migre al AtlasCustomRoles recurso personalizado según la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak so-migrate-ptr8

false

encryptionAtRest

Objeto

EncryptionAtRest permite establecer el cifrado para los proveedores AWS, Azure y GCP.

false

integrations

[]objeto

Integraciones es una lista de MongoDB Atlas integrations para el proyecto. Obsoleto: Migrar al AtlasThirdPartyIntegration recurso personalizado según la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak so-migrate-ptr8

false

maintenanceWindow

Objeto

MaintenanceWindow Permite especificar un horario semanal preferido para ejecutar operaciones de mantenimiento. Consulte más información en https://www.mongodb.com/es/docs/atlas/reference/api/maintenance-windows/

false

networkPeers

[]objeto

NetworkPeers Es una lista de pares de red configurados para el proyecto actual. Obsoleto: Migrar a los AtlasNetworkPeering AtlasNetworkContainer recursos personalizados y de acuerdo con la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak so-migrate-ptr8

false

privateEndpoints

[]objeto

PrivateEndpoints Es una lista de puntos finales privados configurados para el proyecto actual. Obsoleto: Migrar al AtlasPrivateEndpoint recurso personalizado según la guía de migración disponible en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

projectIpAccessList

[]objeto

ProjectIPAccessList Permite el uso de la IP lista de acceso para un proyecto. Consulte más información en https://mongodb.com/es/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: Migrar al AtlasIPAccessList recurso personalizado según la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

false

regionUsageRestrictions

enum

RegionUsageRestrictions Designe la región del proyecto AWS al usar Atlas para Gobierno. Este parámetro no debe usarse con Atlas comercial. En Atlas para Gobierno, si no se configura este campo (el valor predeterminado NONE es), el proyecto se limita COMMERCIAL_FEDRAMP_REGIONS_ONLY a. Enumeración:,,. NONEGOV_REGIONS_ONLYCOMMERCIAL_FEDRAMP_REGIONS_ONLY Valor predeterminado:. NONE

false

settings

Objeto

Configuración permite la configuración de los ajustes del proyecto.

false

teams

[]objeto

Los equipos le permiten otorgar roles de acceso al proyecto a múltiples usuarios.

false

withDefaultAlertsSettings

booleano

Marca que indica si Atlas Kubernetes Operator crea un proyecto con las configuraciones de alerta predeterminadas. Si usa esta configuración, también debe establecer spec.``alertConfigurationSyncEnabled`` en verdadero para que Atlas Kubernetes Operator modifique las configuraciones de alerta del proyecto. Si establece este parámetro en falso al crear un proyecto, Atlas no agrega las configuraciones de alerta predeterminadas al mismo. Esta configuración no afecta a los proyectos existentes. Valor predeterminado: verdadero.

false

x509CertRef

Objeto

X509CertRef es una referencia al secreto de Kubernetes que contiene el certificado CA con codificación PEM. El operador de Kubernetes de Atlas solo supervisa los secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de secretos innecesarios.

false

AtlasProject.spec.alertConfigurations

Name
Tipo
Descripción
Requerido

enabled

booleano

Si se omite, la configuración se deshabilita.

false

eventTypeName

string

El tipo de evento que activará una alerta.

false

matchers

[]objeto

Puede filtrar utilizando la matriz matchers solo cuando EventTypeName especifica un evento para un host, un conjunto de réplicas o un clúster fragmentado.

false

metricThreshold

Objeto

MetricThreshold Provoca que se active una alerta.

false

notifications

[]objeto

Se envían notificaciones cuando se detecta una condición de alerta.

false

severityOverride

enum

SeverityOverride Opcionalmente, anula el nivel de gravedad predeterminado de una alerta. INFOWARNINGEnumeración:,,, ERRORCRITICAL

false

threshold

Objeto

El umbral hace que se active una alerta.

false

AtlasProject.spec.alertConfigurations.matchers

Name
Tipo
Descripción
Requerido

fieldName

string

Nombre del campo en el objeto de destino que va a coincidir.

false

operator

string

El operator para probar el valor del campo.

false

value

string

Valor a probar con el operador especificado.

false

AtlasProject.spec.alertConfigurations.metricThreshold

MetricThreshold hace que se active una alerta.

Name
Tipo
Descripción
Requerido

threshold

string

Valor de umbral fuera del cual se activará una alerta.

true

metricName

string

Nombre de la métrica a comprobar.

false

mode

string

Debe establecerse en AVERAGE. Atlas calcula el valor métrico actual como promedio.

false

operator

string

Operador a aplicar al comparar el valor de la métrica actual con el valor del umbral.

false

units

string

El units para el valor umbral.

false

AtlasProject.spec.alertConfigurations.notificaciones

Name
Tipo
Descripción
Requerido

apiTokenRef

Objeto

Secreto que contiene un token API de Slack o un token de bot. Se rellena para el tipo de notificación SLACK. Si el token deja de ser válido posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

false

channelName

string

Nombre del canal de Slack. Se completa para el tipo de notificación SLACK.

false

datadogAPIKeyRef

Objeto

Secreto que contiene una clave API de Datadog. Se encuentra en el panel de control de Datadog. Se completa para el tipo de notificaciones DATADOG.

false

datadogRegion

string

Región que indica qué API URL utilizar.

false

delayMin

entero

Número de minutos a esperar después de que se detecta una condición de alerta antes de enviar la primera notificación.

false

emailAddress

string

Dirección de correo electrónico a la que se envían las notificaciones de alerta. Se completa para el tipo de notificación EMAIL.

false

emailEnabled

booleano

Indicador que indica si se deben enviar notificaciones por correo electrónico. Se completa para los tipos de notificación ORG, GROUP y USER.

false

flowName

string

Nombre del flujo de Flowdock en letras minúsculas.

false

flowdockApiTokenRef

Objeto

El token personal API de Flowdock. Se completa para el tipo de notificaciones FLOWDOCK. Si posteriormente deja de ser válido, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

false

intervalMin

entero

Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.

false

mobileNumber

string

Número de móvil al que se envían las notificaciones de alerta. Se completa para el tipo de notificación SMS.

false

opsGenieApiKeyRef

Objeto

OpsGenie API Clave. Se rellena para el tipo de notificación OPS_GENIE. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, elimina el token.

false

opsGenieRegion

string

Región que indica qué API URL utilizar.

false

orgName

string

Nombre de la organización de Flowdock en minúsculas. Este es el nombre que aparece después de www.flowdock.com/app/ en la cadena URL. Se completa para el tipo de notificaciones FLOWDOCK.

false

roles

[]cadena

Los siguientes roles otorgan privilegios dentro de un proyecto.

false

serviceKeyRef

Objeto

PagerDuty clave de servicio. Se completa para el tipo de notificaciones PAGER_DUTY. Si la clave más adelante se vuelve inválida, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve la clave.

false

smsEnabled

booleano

Bandera que indica si se deben enviar notificaciones por mensaje de texto. Se rellena para los tipos de notificación ORG, GROUP y USER.

false

teamId

string

Identificador único de un equipo.

false

teamName

string

Etiqueta para el equipo que recibe esta notificación.

false

typeName

string

Tipo de notificación de alerta.

false

username

string

Nombre del usuario de Atlas al que se enviarán las notificaciones. Solo se permite el acceso a un usuario del proyecto que sea propietario de la configuración de alertas. Se completa para el tipo de notificación USER.

false

victorOpsSecretRef

Objeto

Secreto que contiene una clave VictorOps API y una clave de enrutamiento. Completado para el tipo de notificación VICTOR_OPS. Si la clave más adelante se vuelve inválida, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve la clave.

false

AtlasProject.spec.alertConfigurations.notificaciones.apiTokenRef

Secreto que contiene un token de API de Slack o un token de bot. Se rellena para el tipo de notificaciones de SLACK. Si el token deja de ser válido posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.datadogAPIKeyRef

Secreto que contiene una clave API de Datadog. Se encuentra en el panel de control de Datadog. Se completa para el tipo de notificaciones de Datadog.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.flowdockApiTokenRef

El token de API personal de Flowdock. Se completa para el tipo de notificaciones de FLOWDOCK. Si posteriormente deja de ser válido, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notifications.opsGenieApiKeyRef

Clave de API de OpsGenie. Se completa para el tipo de notificaciones OPS_GENIE. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, elimina el token.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.serviceKeyRef

Clave de servicio de PagerDuty. Se rellena para el tipo de notificaciones PAGER_DUTY. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, la elimina.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.victorOpsSecretRef

Secreto que contiene una clave de API de VictorOps y una clave de enrutamiento. Se rellena para el tipo de notificaciones VICTOR_OPS. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, la elimina.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.threshold

El umbral hace que se active una alerta.

Name
Tipo
Descripción
Requerido

operator

string

Operador que se aplica al comparar el valor de la métrica actual con el valor umbral. Acepta los siguientes valores: GREATER_THAN, LESS_THAN.

false

threshold

string

Valor de umbral fuera del cual se activará una alerta.

false

units

string

El units para el valor umbral.

false

Auditoría de especificaciones del proyecto Atlas

La auditoría representa las ventanas de mantenimiento de MongoDB.

Name
Tipo
Descripción
Requerido

auditAuthorizationSuccess

booleano

Indica si el sistema de auditoría captura los intentos de autenticación correctos para los filtros de auditoría mediante el evento de auditoría "atype": "authCheck". Para más información, consulte auditAuthorizationSuccess.

false

auditFilter

string

JSON-Filtro de auditoría formateado utilizado por el proyecto.

false

enabled

booleano

Indica si el proyecto asociado con {GROUP-ID} tiene habilitada la auditoría de base de datos.

false

AtlasProject.spec.backupCompliancePolicyRef

BackupCompliancePolicyRef es una referencia al recurso personalizado de cumplimiento de copia de seguridad.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.cloudProviderAccessRoles

CloudProviderAccessRole define una integración con un proveedor de nube OBSOLETO: Este tipo está obsoleto en favor de CloudProviderIntegration

Name
Tipo
Descripción
Requerido

providerName

string

ProviderName es el nombre del proveedor de nube. Actualmente, solo se admite AWS.

true

iamAssumedRoleArn

string

IamAssumedRoleArn es el ARN del rol IAM que asume el clúster Atlas.

false

AtlasProject.spec.cloudProviderIntegrations

CloudProviderIntegration define una integración con un proveedor de nube

Name
Tipo
Descripción
Requerido

providerName

string

ProviderName es el nombre del proveedor de nube. Actualmente, solo se admite AWS.

true

iamAssumedRoleArn

string

IamAssumedRoleArn es el ARN del rol IAM que asume el clúster Atlas.

false

AtlasProject.spec.connectionSecretRef

ConnectionSecret es el nombre del secreto de Kubernetes que contiene la información sobre cómo conectarse a Atlas (ID de la organización, claves API). Si no se proporciona, se utilizará la configuración de conexión predeterminada del operador.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.customRoles

CustomRole permite crear y modificar un rol personalizado en el clúster. Use roles personalizados para especificar conjuntos de acciones personalizados que los roles integrados de Atlas no pueden describir. Obsoleto: Migre al recurso personalizado AtlasCustomRoles según la guía de migración disponible en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible que identifica el rol. Este name debe ser único para este rol personalizado en este proyecto.

true

actions

[]objeto

Lista de los privilegios individuales actions que otorga el rol.

false

inheritedRoles

[]objeto

Lista de los roles integrados que hereda este rol personalizado.

false

AtlasProject.spec.customRoles.acciones

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible por humanos que identifica la acción privilegiada.

true

resources

[]objeto

Lista de resources en los que se concede la acción.

true

AtlasProject.spec.customRoles.acciones.recursos

Name
Tipo
Descripción
Requerido

cluster

booleano

Marca que indica si se debe conceder la acción en el recurso cluster. Si es verdadero, MongoDB Cloud ignora los parámetros de base de datos y colección.

false

collection

string

Etiqueta legible por humanos que identifica el collection en el que se otorga la acción a un usuario MongoDB.

false

database

string

Etiqueta legible por humanos que identifica el database en el que se otorga la acción a un usuario MongoDB.

false

AtlasProject.spec.customRoles.inheritedRoles

Name
Tipo
Descripción
Requerido

database

string

Etiqueta legible por humanos que identifica el database en el que se otorga la acción a un usuario MongoDB.

true

name

string

Etiqueta legible por humanos que identifica el rol heredado.

true

AtlasProject.spec.encryptionAtRest

EncryptionAtRest permite configurar el cifrado para proveedores de AWS, Azure y GCP.

Name
Tipo
Descripción
Requerido

awsKms

Objeto

AwsKms especifica AWS KMS detalles de configuración y si el cifrado en reposo está habilitado para un proyecto Atlas.

false

azureKeyVault

Objeto

AzureKeyVault Especifica los detalles de configuración de Azure Key Vault y si el cifrado en reposo está habilitado para un proyecto Atlas.

false

googleCloudKms

Objeto

GoogleCloudKms especifica GCP KMS detalles de configuración y si el cifrado en reposo está habilitado para un proyecto Atlas.

false

Proyecto Atlas.spec.encryptionAtRest.awsKms

AwsKms especifica los detalles de configuración de AWS KMS y si el cifrado en reposo está habilitado para un proyecto Atlas.

Name
Tipo
Descripción
Requerido

enabled

booleano

Especifica si el cifrado en reposo está enabled para un proyecto Atlas. Para desactivar el cifrado en reposo, pasa solo este parámetro con un valor de falso. Cuando desactives el cifrado en reposo, Atlas también removerá los detalles de la configuración.

false

region

string

El AWS region en el que existe la clave maestra del cliente AWS.

false

secretRef

Objeto

Una referencia a un Secret que contenga los campos AccessKeyID, SecretAccessKey, CustomerMasterKeyID y RoleID.

false

valid

booleano

Especifica si la clave de cifrado establecida para el proveedor es valid y puede utilizarse para cifrar y descifrar datos.

false

Proyecto Atlas.spec.encryptionAtRest.awsKms.secretRef

Una referencia a un secreto que contiene los campos AccessKeyID, SecretAccessKey, CustomerMasterKeyID y RoleID

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Proyecto Atlas.spec.encryptionAtRest.azureKeyVault

AzureKeyVault especifica los detalles de configuración de Azure Key Vault y si el cifrado en reposo está habilitado para un proyecto Atlas.

Name
Tipo
Descripción
Requerido

azureEnvironment

string

El entorno de Azure donde residen las credenciales de la cuenta de Azure. Los valores válidos son los siguientes: AZURE, AZURE_CHINA, AZURE_GERMANY

false

clientID

string

El cliente ID, también conocido como la aplicación ID, para una aplicación de Azure asociada con el inquilino de Azure AD.

false

enabled

booleano

Especifica si el cifrado en reposo está enabled para un proyecto Atlas. Para desactivar el cifrado en reposo, pasa solo este parámetro con un valor de falso. Cuando desactives el cifrado en reposo, Atlas también removerá los detalles de la configuración.

false

resourceGroupName

string

El nombre del grupo de recursos de Azure que contiene un Azure Key Vault.

false

secretRef

Objeto

Una referencia a un secreto que contiene los campos SubscriptionID, KeyVaultName, KeyIdentifier, Secreto

false

tenantID

string

El identificador único de un inquilino de Azure AD dentro de una suscripción de Azure.

false

Proyecto Atlas.spec.encryptionAtRest.azureKeyVault.secretRef

Una referencia a un secreto que contiene los campos SubscriptionID, KeyVaultName, KeyIdentifier y Secret

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Proyecto Atlas.spec.encryptionAtRest.googleCloudKms

GoogleCloudKms especifica los detalles de configuración de GCP KMS y si el cifrado en reposo está habilitado para un proyecto Atlas.

Name
Tipo
Descripción
Requerido

enabled

booleano

Especifica si el cifrado en reposo está enabled para un proyecto Atlas. Para desactivar el cifrado en reposo, pasa solo este parámetro con un valor de falso. Cuando desactives el cifrado en reposo, Atlas también removerá los detalles de la configuración.

false

secretRef

Objeto

Una referencia a un secreto que contiene los campos ServiceAccountKey, KeyVersionResourceID

false

Proyecto Atlas.spec.encryptionAtRest.googleCloudKms.secretRef

Una referencia a un secreto que contiene los campos ServiceAccountKey y KeyVersionResourceID

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Integraciones de AtlasProject.spec.

Integración para el proyecto entre Atlas y un servicio de terceros. Obsoleto: Migrar al recurso personalizado AtlasThirdPartyIntegration según la guía de migración disponible en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

accountId

string

Cadena de dígitos hexadecimales 40única que identifica su cuenta de New Relic.

false

apiKeyRef

Objeto

Referencia a un secreto de Kubernetes que contiene su clave API para Datadog, OpsGenie o Victor Ops.

false

apiTokenRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave que permite a Atlas acceder a su cuenta de Slack.

false

channelName

string

Nombre del canal de Slack al que Atlas envía notificaciones de alerta.

false

enabled

booleano

Bandera que indica si alguien ha activado la integración de Prometheus.

false

flowName

string

DEPRECATEDNombre del flujo de Flowdock. Este campo se ha eliminado de Atlas y no tiene efecto.

false

licenseKeyRef

Objeto

Referencia a un secreto de Kubernetes que contiene su cadena de dígitos hexadecimales 40única que identifica su licencia de New Relic.

false

microsoftTeamsWebhookUrl

string

Dirección web del punto final del webhook de Microsoft Teams al que Atlas envía notificaciones.

false

name

string

false

orgName

string

DEPRECATEDNombre de la organización de Flowdock. Este campo se ha eliminado de Atlas y no tiene efecto.

false

passwordRef

Objeto

Referencia a un secreto de Kubernetes que contiene la contraseña para permitir que Atlas acceda a su cuenta de Prometheus.

false

readTokenRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave de consulta asociada con su cuenta de New Relic.

false

region

string

Código de región que indica qué Atlas regional API utiliza para acceder a PagerDuty, Datadog o OpsGenie.

false

routingKeyRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave de enrutamiento asociada a su cuenta de Splunk On-Call. Se utiliza para Victor Ops.

false

scheme

string

false

secretRef

Objeto

Referencia a un secreto de Kubernetes que contiene el secreto de su webhook.

false

serviceDiscovery

string

Método deseado para descubrir el servicio Prometheus.

false

serviceKeyRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave de servicio asociada con su cuenta PagerDuty.

false

teamName

string

Etiqueta legible para humanos que identifica a tu equipo de Slack.

false

type

enum

Integración de type terceros, como Slack, New Relic, etc. Cada integración type requiere un conjunto distinto de campos de configuración. Por ejemplo,type si DATADOG configura como, solo debe configurar los subcampos de Datadog. Enumeración:,,,,,,,,, PAGER_DUTYSLACKDATADOGNEW_RELICOPS_GENIEVICTOR_OPSFLOWDOCKWEBHOOKMICROSOFT_TEAMSPROMETHEUS

false

url

string

Dirección web del punto final al que Atlas envía notificaciones. Se utiliza para webhooks.

false

username

string

Etiqueta legible por humanos que identifica su webhook entrante de Prometheus.

false

writeTokenRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave de inserción asociada con su cuenta de New Relic.

false

AtlasProject.spec.integrations.apiKeyRef

Referencia a un secreto de Kubernetes que contiene su clave API para Datadog, OpsGenie o Victor Ops.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.apiTokenRef

Referencia a un secreto de Kubernetes que contiene la clave que permite a Atlas acceder a su cuenta de Slack.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.licenseKeyRef

Referencia a un secreto de Kubernetes que contiene su cadena de dígitos hexadecimales 40única que identifica su licencia de New Relic.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.passwordRef

Referencia a un secreto de Kubernetes que contiene la contraseña para permitir que Atlas acceda a su cuenta de Prometheus.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.readTokenRef

Referencia a un secreto de Kubernetes que contiene la clave de consulta asociada con su cuenta de New Relic.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.routingKeyRef

Referencia a un secreto de Kubernetes que contiene la clave de enrutamiento asociada a su cuenta de Splunk On-Call. Se utiliza para Victor Ops.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.secretRef

Referencia a un secreto de Kubernetes que contiene el secreto de su webhook.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.serviceKeyRef

Referencia a un secreto de Kubernetes que contiene la clave de servicio asociada con su cuenta de PagerDuty.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

AtlasProject.spec.integrations.writeTokenRef

Referencia a un secreto de Kubernetes que contiene la clave de inserción asociada con su cuenta de New Relic.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Ventana de mantenimiento de AtlasProject.spec

MaintenanceWindow permite especificar el horario de la semana preferido para ejecutar operaciones de mantenimiento. Consulte más información en https://www.mongodb.com/es/docs/atlas/reference/api/maintenance-windows/

Name
Tipo
Descripción
Requerido

autoDefer

booleano

Bandera que indica si cualquier mantenimiento programado del proyecto debe posponerse automáticamente por una semana.

false

dayOfWeek

entero

Día de la semana en el que te gustaría que el periodo de mantenimiento comenzara como un entero basado en 1. Domingo 1, Lunes 2, Martes 3, Miércoles 4, Jueves 5, Viernes 6, Sábado 7. Mínimo: 1 Máximo: 7

false

defer

booleano

Marca que indica si el próximo mantenimiento programado del proyecto debe posponerse una semana. No se puede especificar si startASAP es verdadero.

false

hourOfDay

entero

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

false

startASAP

booleano

Marca que indica si se ha ordenado el inicio inmediato del mantenimiento del proyecto. No se puede especificar si el aplazamiento es verdadero.

false

AtlasProject.spec.networkPeers

NetworkPeer configurado para el proyecto actual. Obsoleto: Migrar a los recursos personalizados AtlasNetworkPeering y AtlasNetworkContainer según la guía de migración disponible en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

accepterRegionName

string

AccepterRegionName es el nombre de la región del proveedor del usuario VPC.

false

atlasCidrBlock

string

Atlas CIDR. Debe configurarse si ContainerID no está configurado.

false

awsAccountId

string

AccountID del VPC del usuario.

false

azureDirectoryId

string

AzureDirectoryID es el identificador único de un directorio de Azure AD.

false

azureSubscriptionId

string

AzureSubscriptionID es el identificador único de la suscripción de Azure en la que reside la red virtual.

false

containerId

string

ID del contenedor de pares de la red. Si no se configura, el operador creará un nuevo contenedor con las entradas ContainerRegion y AtlasCIDRBlock.

false

containerRegion

string

ContainerRegion Es el nombre de la región del proveedor del contenedor de pares de la red Atlas. Si no se configura, se utiliza AccepterRegionName.

false

gcpProjectId

string

Usuario GCP Proyecto ID. Aplica solo para GCP.

false

networkName

string

GCP Nombre del par de la red. Aplica solo para GCP.

false

providerName

string

ProviderName Es el nombre del proveedor. Si no se configura, se establecerá en "AWS".

false

resourceGroupName

string

ResourceGroupName es el nombre de su grupo de recursos de Azure.

false

routeTableCidrBlock

string

Usuario VPC CIDR.

false

vnetName

string

VNetName es el nombre de su red virtual de Azure. Solo se aplica a Azure.

false

vpcId

string

AWS VPC ID.

false

AtlasProject.spec.puntos finales privados

Punto de conexión privado es una lista de puntos de conexión privados configurados para el proyecto actual. Obsoleto: Migre al recurso personalizado Punto de conexión privado de Atlas según la guía de migración disponible en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

provider

enum

Nube provider para la que se desea recuperar un servicio de nodos privados. Atlas acepta AWS, GCP o AZURE. Enum: AWS, GCP, AZURE, TENANT

true

region

string

Proveedor de nube region para el que desea crear el servicio de punto final privado.

true

endpointGroupName

string

Identificador único del grupo de endpoints. Este grupo abarca todos los endpoints que creaste en Google Cloud.

false

endpoints

[]objeto

Colección de endpoints privados individuales que componen su grupo de puntos finales.

false

gcpProjectId

string

Identificador único del proyecto de Google Cloud en el que creaste tus puntos finales.

false

id

string

Identificador único del punto final privado que creó en su AWS VPC o Azure VNet.

false

ip

string

Dirección privada IP de la interfaz de red de punto final privado que creó en su red virtual de Azure.

false

AtlasProject.spec.privateEndpoints.puntos finales

Name
Tipo
Descripción
Requerido

endpointName

string

Regla de reenvío que corresponde al punto final que creaste en Google Cloud.

false

ipAddress

string

Dirección privada IP del punto final que creaste en Google Cloud.

false

AtlasProject.spec.projectIpAccessList

IPAccessList permite usar la lista de acceso IP para un proyecto. Consulte más información en https://mongodb.com/es/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/. Obsoleto: Migre al recurso personalizado AtlasIPAccessList según la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak so-migrate-ptr8

Name
Tipo
Descripción
Requerido

awsSecurityGroup

string

Identificador único del grupo de seguridad AWS en esta entrada de la lista de control de acceso.

false

cidrBlock

string

Rango de IP direcciones en notación CIDR en esta entrada de lista de acceso.

false

comment

string

Comentario asociado con esta entrada en la lista de acceso.

false

deleteAfterDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC después de la cual Atlas elimina la entrada de la lista de acceso temporal.

false

ipAddress

string

Entrada usando una dirección IP en esta entrada de lista de acceso.

false

AtlasProject.spec.settings

Configuración permite la configuración de los ajustes del proyecto.

Name
Tipo
Descripción
Requerido

isCollectDatabaseSpecificsStatisticsEnabled

booleano

Bandera que indica si se deben recopilar métricas específicas de la base de datos para el proyecto especificado.

false

isDataExplorerEnabled

booleano

Bandera que indica si se debe habilitar el Explorador de datos para el proyecto especificado.

false

isExtendedStorageSizesEnabled

booleano

Bandera que indica si se deben habilitar tamaños de almacenamiento extendidos para el proyecto especificado.

false

isPerformanceAdvisorEnabled

booleano

Bandera que indica si se debe habilitar el Asesor de rendimiento y el Generador de perfiles para el proyecto especificado.

false

isRealtimePerformancePanelEnabled

booleano

Bandera que indica si se debe habilitar el Panel de rendimiento en tiempo real para el proyecto especificado.

false

isSchemaAdvisorEnabled

booleano

Bandera que indica si se debe habilitar el Asesor de esquemas para el proyecto especificado.

false

Equipos de especificación del proyecto Atlas

Name
Tipo
Descripción
Requerido

roles

[]enum

Roles que los usuarios del equipo tienen dentro del proyecto. Enum: GROUP_OWNER, GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_WRITE, GROUP_DATA_ACCESS_READ_ONLY, GROUP_READ_ONLY

true

teamRef

Objeto

Referencia al recurso personalizado AtlasTeam que se asignará al proyecto.

true

Proyecto Atlas.spec.equipos.referenciadeequipo

Referencia al recurso personalizado AtlasTeam que se asignará al proyecto.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Proyecto Atlas.spec.x509Referencia de certificado

X509CertRef es una referencia al secreto de Kubernetes que contiene el certificado de CA codificado en PEM. El operador de Kubernetes de Atlas solo supervisa los secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar la supervisión de secretos innecesarios.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Estado del proyecto Atlas

AtlasProjectStatus define el estado observado de AtlasProject

Name
Tipo
Descripción
Requerido

conditions

[]objeto

Condiciones es la lista de estados que muestra el estado actual del recurso personalizado de Atlas

true

alertConfigurations

[]objeto

AlertConfigurations contiene una lista de estados de configuración de alertas

false

authModes

[]cadena

AuthModes contiene una lista de modos de autenticación configurados "SCRAM" es el método de autenticación predeterminado y requiere una contraseña para cada usuario "X509" significa que la autenticación X.509 autoadministrada está configurada

false

cloudProviderIntegrations

[]objeto

CloudProviderIntegrations Contiene una lista de roles de acceso de proveedores de nube configurados. AWS Solo soporte

false

customRoles

[]objeto

CustomRoles Contiene una lista de estados de roles personalizados

false

expiredIpAccessList

[]objeto

La lista de entradas de la Lista de Acceso IP que han expirado debido a que 'deleteAfterDate' es anterior a la fecha actual. Tenga en cuenta que el Operador Atlas actualiza este campo solo después de cambios en las especificaciones.

false

id

string

El ID del Proyecto Atlas

false

networkPeers

[]objeto

La lista de pares de red que están configurados para el proyecto actual

false

observedGeneration

entero

ObservedGeneration Indica la generación de la especificación del recurso que el operador Atlas conoce. El operador Atlas actualiza este campo con el valor 'metadata.generation' en cuanto inicia la conciliación del recurso. Formato: int64

false

privateEndpoints

[]objeto

La lista de puntos finales privados configurados para el proyecto actual

false

prometheus

Objeto

Prometheus contiene el estado de la integración de Prometheus, incluido el prometheusDiscoveryURL

false

teams

[]objeto

Teams contiene una lista de teams estados de asignación

false

AtlasProject.estado.condiciones

La condición describe el estado de un recurso personalizado de Atlas en un momento determinado.

Name
Tipo
Descripción
Requerido

status

string

Estado de la condición; uno de Verdadero, Falso, Desconocido.

true

type

string

Tipo de condición de recurso personalizado de Atlas.

true

lastTransitionTime

string

Última vez que la condición cambió de un estado a otro. Representado en ISO 8601 formato. Formato: fecha y hora.

false

message

string

A message proporcionando detalles sobre la transición.

false

reason

string

El reason para la última transición de la condición.

false

Configuraciones de alerta de estado de AtlasProject

Name
Tipo
Descripción
Requerido

acknowledgedUntil

string

Fecha de acuse de recibo de la alerta. No aparecerá si la alerta nunca se acusó de recibo.

false

acknowledgementComment

string

El comentario del usuario que reconoció la alerta. No aparecerá si la alerta nunca fue reconocida.

false

acknowledgingUsername

string

El nombre de usuario que confirmó la alerta. No estará presente si la alerta nunca fue confirmada.

false

alertConfigId

string

ID de la configuración de alerta que activó esta alerta.

false

clusterId

string

El ID del clúster al que se aplica esta alerta. Solo está presente para alertas de tipo BACKUP, REPLICA_SET y CLUSTER.

false

clusterName

string

El nombre del clúster al que se aplica esta alerta. Solo está presente para alertas de tipo BACKUP, REPLICA_SET y CLUSTER.

false

created

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se creó esta configuración de alerta.

false

currentValue

Objeto

CurrentValue Representa el valor actual de la métrica que activó la alerta. Solo está presente para alertas de tipo HOST_METRIC.

false

enabled

booleano

Si se omite, la configuración se deshabilita.

false

errorMessage

string

ErrorMessage es un masaje si la configuración de alerta está en un estado incorrecto.

false

eventTypeName

string

El tipo de evento que activará una alerta.

false

groupId

string

Identificador único del proyecto que posee esta configuración de alerta.

false

hostId

string

ID del host al que pertenece la métrica. Solo está presente para alertas de tipo HOST, HOST_METRIC y REPLICA_SET.

false

hostnameAndPort

string

El nombre de host y el puerto de cada host al que se aplica la alerta. Solo está presente para alertas de tipo HOST, HOST_METRIC y REPLICA_SET.

false

id

string

Unique identifier.

false

lastNotified

string

Cuándo se envió la última notificación para esta alerta. Solo aparece si se enviaron notificaciones.

false

matchers

[]objeto

Puede filtrar utilizando la matriz matchers solo cuando EventTypeName especifica un evento para un host, un conjunto de réplicas o un clúster fragmentado.

false

metricName

string

El nombre de la métrica cuyo valor excedió el umbral. Solo se presenta si eventTypeName está configurado en OUTSIDE_METRIC_THRESHOLD.

false

metricThreshold

Objeto

MetricThreshold Provoca que se active una alerta.

false

notifications

[]objeto

Se envían notificaciones cuando se detecta una condición de alerta.

false

replicaSetName

string

Nombre del conjunto de réplicas. Solo está presente para alertas de tipo HOST, HOST_METRIC, BACKUP y REPLICA_SET.

false

resolved

string

Cuando se cerró la alerta. Solo está presente si el estado es CLOSED.

false

severityOverride

string

Gravedad de la alerta.

false

sourceTypeName

string

Para alertas del tipo BACKUP, el tipo de servidor del que se está realizando una copia de seguridad.

false

status

string

Estado actual de la alerta. Valores posibles: TRACKING, OPEN, CLOSED, CANCELED

false

threshold

Objeto

El umbral hace que se active una alerta.

false

updated

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando se actualizó por última vez esta configuración de alerta.

false

AtlasProject.status.alertConfigurations.currentValue

CurrentValue representa el valor actual de la métrica que activó la alerta. Solo está presente en alertas de tipo HOST_METRIC.

Name
Tipo
Descripción
Requerido

number

string

El valor de la métrica.

false

units

string

El units para el valor. Depende del tipo de métrica.

false

AtlasProject.status.alertConfigurations.matchers

Name
Tipo
Descripción
Requerido

fieldName

string

Nombre del campo en el objeto de destino que va a coincidir.

false

operator

string

El operator para probar el valor del campo.

false

value

string

Valor a probar con el operador especificado.

false

AtlasProject.status.alertConfigurations.metricThreshold

MetricThreshold hace que se active una alerta.

Name
Tipo
Descripción
Requerido

threshold

string

Valor de umbral fuera del cual se activará una alerta.

true

metricName

string

Nombre de la métrica a comprobar.

false

mode

string

Debe establecerse en AVERAGE. Atlas calcula el valor métrico actual como promedio.

false

operator

string

Operador a aplicar al comparar el valor de la métrica actual con el valor del umbral.

false

units

string

El units para el valor umbral.

false

AtlasProject.status.alertConfigurations.notificaciones

Name
Tipo
Descripción
Requerido

apiToken

string

Token Slack API o token de Bot. Llenado para el tipo de notificaciones SLACK. Si el token se vuelve inválido posteriormente, Atlas envía un correo electrónico al propietario del proyecto y eventualmente remueve el token.

false

channelName

string

Nombre del canal de Slack. Se completa para el tipo de notificación SLACK.

false

datadogApiKey

string

Clave Datadog API. Se encuentra en el tablero de Datadog. Se genera para el tipo de notificaciones DATADOG.

false

datadogRegion

string

Región que indica qué API URL utilizar

false

delayMin

entero

Número de minutos a esperar después de que se detecta una condición de alerta antes de enviar la primera notificación.

false

emailAddress

string

Dirección de correo electrónico a la que se envían las notificaciones de alerta. Se completa para el tipo de notificación EMAIL.

false

emailEnabled

booleano

Indicador que indica si se deben enviar notificaciones por correo electrónico. Se completa para los tipos de notificación ORG, GROUP y USER.

false

flowName

string

Nombre del flujo de Flowdock en letras minúsculas.

false

flowdockApiToken

string

El token personal API de Flowdock. Se completa para el tipo de notificaciones FLOWDOCK. Si posteriormente deja de ser válido, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, lo elimina.

false

intervalMin

entero

Número de minutos de espera entre notificaciones sucesivas de alertas no reconocidas que no se resuelven.

false

mobileNumber

string

Número de móvil al que se envían las notificaciones de alerta. Se completa para el tipo de notificación SMS.

false

opsGenieApiKey

string

Clave API de Opsgenie. Se rellena para el tipo de notificación OPS_GENIE. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, elimina el token.

false

opsGenieRegion

string

Región que indica qué API URL utilizar.

false

orgName

string

Nombre de la organización de Flowdock en minúsculas. Este es el nombre que aparece después de www.flowdock.com/app/ en la cadena URL. Se completa para el tipo de notificaciones FLOWDOCK.

false

roles

[]cadena

Los siguientes roles otorgan privilegios dentro de un proyecto.

false

serviceKey

string

PagerDuty clave de servicio. Se completa para el tipo de notificaciones PAGER_DUTY. Si la clave más adelante se vuelve inválida, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve la clave.

false

smsEnabled

booleano

Bandera que indica si se deben enviar notificaciones por mensaje de texto. Se rellena para los tipos de notificación ORG, GROUP y USER.

false

teamId

string

Identificador único de un equipo.

false

teamName

string

Etiqueta para el equipo que recibe esta notificación.

false

typeName

string

Tipo de notificación de alerta.

false

username

string

Nombre del usuario de Atlas al que se enviarán las notificaciones. Solo se permite el acceso a un usuario del proyecto que sea propietario de la configuración de alertas. Se completa para el tipo de notificación USER.

false

victorOpsApiKey

string

VictorOps API Clave. Se rellena para el tipo de notificación VICTOR_OPS. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, la elimina.

false

victorOpsRoutingKey

string

VictorOps Clave de enrutamiento. Se rellena para el tipo de notificación VICTOR_OPS. Si la clave deja de ser válida posteriormente, Atlas envía un correo electrónico al propietario del proyecto y, finalmente, la elimina.

false

AtlasProject.status.alertConfigurations.threshold

El umbral hace que se active una alerta.

Name
Tipo
Descripción
Requerido

operator

string

Operador que se debe aplicar al comparar el valor de la métrica actual con el valor del umbral. Acepta los siguientes valores: GREATER_THAN, LESS_THAN

false

threshold

string

Valor de umbral fuera del cual se activará una alerta.

false

units

string

El units para el valor umbral

false

Integraciones de AtlasProject.status.cloudProvider

Name
Tipo
Descripción
Requerido

atlasAssumedRoleExternalId

string

ID externo único que MongoDB Atlas utiliza cuando asume el rol IAM en su cuenta de Amazon Web Services.

true

providerName

string

Etiqueta legible por humanos que identifica al proveedor de nube del rol.

true

atlasAWSAccountArn

string

Nombre de recurso de Amazon que identifica la cuenta de usuario de Amazon Web Services que MongoDB Atlas utiliza cuando asume el rol de Administración de identidad y acceso.

false

authorizedDate

string

Fecha y hora en que se autorizó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato ISO 8601 timestamp en UTC.

false

createdDate

string

Fecha y hora en que alguien creó este rol para el proveedor de servicios en la nube especificado. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC.

false

errorMessage

string

Mensaje de error de la aplicación devuelto.

false

featureUsages

[]objeto

Lista que contiene funcionalidades de la aplicación asociadas con este rol de Amazon Web Services Identity and Access gestión.

false

iamAssumedRoleArn

string

Nombre de recurso de Amazon que identifica la función de administración de acceso e identidad de Amazon Web Services que MongoDB Cloud asume cuando accede a los recursos de su cuenta AWS.

false

roleId

string

Cadena de dígitos hexadecimales 24única que identifica el rol.

false

status

string

Aprovisionamiento status de la cuenta de servicio. Los valores son IN_PROGRESS, COMPLETE, FAILED o NOT_INITIATED.

false

AtlasProject.status.cloudProviderIntegrations.featureUsages

Name
Tipo
Descripción
Requerido

featureId

string

Identificar características sobre el lago de datos vinculado a esta función de administración de acceso e identidad de Amazon Web Services.

false

featureType

string

Etiqueta legible por humanos que describe una función de la nube MongoDB vinculada a esta función de administración de acceso e identidad de Amazon Web Services.

false

AtlasProject.status.customRoles

Name
Tipo
Descripción
Requerido

name

string

Rol name que es único

true

status

string

El status del rol personalizado dado (OK o FAILED)

true

error

string

El mensaje cuando el rol personalizado está en el estado FAILED

false

AtlasProject.status.expiredIpAccessList

IPAccessList permite usar la lista de acceso IP para un proyecto. Consulte más información en https://mongodb.com/es/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/. Obsoleto: Migre al recurso personalizado AtlasIPAccessList según la guía de migración en https://www.mongodb.com/es/docs/atlas/operator/current/migrate-parameter-to-resource/#std-label-ak so-migrate-ptr8

Name
Tipo
Descripción
Requerido

awsSecurityGroup

string

Identificador único del grupo de seguridad AWS en esta entrada de la lista de control de acceso.

false

cidrBlock

string

Rango de IP direcciones en notación CIDR en esta entrada de lista de acceso.

false

comment

string

Comentario asociado con esta entrada en la lista de acceso.

false

deleteAfterDate

string

Marca de tiempo en formato de fecha y hora ISO 8601 en UTC después de la cual Atlas elimina la entrada de la lista de acceso temporal.

false

ipAddress

string

Entrada usando una dirección IP en esta entrada de lista de acceso.

false

AtlasProject.status.networkPeers

Name
Tipo
Descripción
Requerido

id

string

Identificador único para NetworkPeer.

true

providerName

string

Proveedor de nube del que desea recuperar un par de red.

true

region

string

Región para la que desea crear el par de red. No es necesario para GCP

true

atlasGcpProjectId

string

ProjectID del contenedor Atlas. Aplicable solo para GCP. Es necesario para agregar una conexión de red entre pares.

false

atlasNetworkName

string

Nombre de la red Atlas. Aplicable solo para GCP. Es necesario para agregar la conexión de red.

false

connectionId

string

Identificador único de la conexión de red. Aplicable solo para AWS.

false

containerId

string

ContainerID del contenedor de pares de la red Atlas.

false

errorMessage

string

Estado de error del par de la red. Aplicable solo para GCP.

false

errorState

string

Estado de error del par de red. Aplicable solo para Azure.

false

errorStateName

string

Estado de error del par de la red. Aplicable solo para AWS.

false

gcpProjectId

string

ProjectID del VPC del usuario. Aplicable solo para GCP.

false

status

string

Estado del par de red. Aplicable solo para GCP y Azure.

false

statusName

string

Estado del par de la red. Aplicable solo para AWS.

false

vpc

string

VPC es un campo de propósito general para almacenar el nombre de VPC. VPC es vpcID para AWS, el usuario networkName para GCP y vnetName para Azure.

false

AtlasProject.status.privateEndpoints

Name
Tipo
Descripción
Requerido

provider

string

Nube provider para la que desea recuperar un servicio de punto final privado. Atlas acepta AWS o AZURE.

true

region

string

Proveedor de nube region para el que desea crear el servicio de punto final privado.

true

endpoints

[]objeto

Colección de GCP privados endpoints individuales que componen su grupo de puntos finales de red.

false

id

string

Identificador único para la conexión de enlace privado AWS o AZURE.

false

interfaceEndpointId

string

Identificador único del AWS o Endpoint de la interfaz de Azure Private Link.

false

serviceAttachmentNames

[]cadena

Cadenas únicas alfanuméricas y de caracteres especiales que identifican los adjuntos de servicio asociados al servicio de endpoint Private Service Connect GCP.

false

serviceName

string

Nombre del AWS o servicio de enlace privado de Azure que administra Atlas.

false

serviceResourceId

string

Identificador único del servicio de vínculo privado de Azure (para AWS lo mismo que ID).

false

AtlasProject.status.privateEndpoints.endpoints

Name
Tipo
Descripción
Requerido

endpointName

string

Etiqueta legible por humanos que identifica la regla de reenvío de consumidores de Google Cloud que usted creó.

true

ipAddress

string

Una dirección de Protocolo de Internet privado versión 4 (IPv4) en la que se resuelve esta regla de reenvío de consumidor de Google Cloud.

true

status

string

Estado del grupo de endpoints MongoDB de Atlas cuando MongoDB nube recibió esta solicitud.

true

AtlasProject.status.prometheus

Prometheus contiene el estado de la integración de Prometheus, incluido prometheusDiscoveryURL

Name
Tipo
Descripción
Requerido

prometheusDiscoveryURL

string

URL de donde Prometeo obtiene los objetivos.

false

scheme

string

Protocolo scheme utilizado para solicitudes de Prometheus.

false

AtlasProject.status.teams

Name
Tipo
Descripción
Requerido

teamRef

Objeto

ResourceRefNamespaced es una referencia a un recurso de Kubernetes que permite configurar el espacio de nombres

true

id

string

false

AtlasProject.status.teams.teamRef

ResourceRefNamespaced es una referencia a un recurso de Kubernetes que permite configurar el espacio de nombres

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

Espacio de nombres del recurso de Kubernetes

false

Volver

Recursos personalizados

Next

Implementación de Atlas

En esta página