Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /
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. Cuando creas el recurso personalizado AtlasProject, Atlas Kubernetes Operator intenta crear un nuevo proyecto en Atlas.

Importante

Recursos personalizados ya no borran objetos por defecto

  • Atlas Kubernetes Operator utiliza Archivos de configuración de recursos personalizados para gestionar tu configuración de Atlas, pero a partir de Atlas Kubernetes Operator 2.0, los recursos personalizados que elimines en Kubernetes ya no se eliminarán (por defecto) en Atlas. En su lugar, el Operador de Kubernetes Atlas simplemente deja de gestionar esos recursos en Atlas. Por ejemplo, si eliminas 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 en el comportamiento está destinado a ayudar a prevenir eliminaciones accidentales o inesperadas. Para obtener más información, incluido cómo revertir este comportamiento al por defecto utilizado antes del Atlas Kubernetes Operator 2.0, consulte Nuevo valor predeterminado: Protección contra eliminación en Atlas Kubernetes Operator 2.0.

    Del mismo modo, Atlas Kubernetes Operator no elimina los equipos de Atlas si los eliminas de un proyecto Atlas en Kubernetes utilizando Atlas Kubernetes Operator.

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

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

Atlas Kubernetes Operator realiza una de las siguientes acciones:

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

Por defecto, el Atlas Kubernetes Operator guarda los secrets 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 puedes editar la especificación de recurso personalizado AtlasProject para configurar las siguientes opciones:

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

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 tablero de muestra de Grafana 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 Teams.

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 especificación de recurso personalizado AtlasProject que deshabilita la recopilación de estadísticas de bases de datos en métricas de clúster, explorador de datos, Performance Advisor, Panel de rendimiento en tiempo real y 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 alerta de terceros

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

Name
Tipo
Descripción
Requerido

apiVersion

string

atlas.mongodb.com/v1

true

kind

string

AtlasProject

true

metadata

Objeto

Consulta la documentación de Kubernetes API para obtener información sobre 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. La longitud de name no debe superar los 64 caracteres. El name debe contener solo letras, números, espacios, guiones y guiones bajos. validación:

  • 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/deshabilita la sincronización de las Configuraciones de Alertas para el Proyecto actual. Si es verdadero - las configuraciones de alertas del proyecto se sincronizarán de acuerdo con AlertConfigurations. Si no es así, las configuraciones de alerta no serán modificadas por el operador. Se pueden gestionar a través del API, CLI y UI.

false

alertConfigurations

[]objeto

AlertConfiguration es una lista de configuraciones de alertas configuradas para el proyecto actual. Si se utiliza este ajuste, también se debe configurar spec.``alertConfigurationSyncEnabled`` como verdadero para que el Atlas Kubernetes Operator pueda modificar las configuraciones de alertas del proyecto. Si omites o dejas esta configuración vacía, Atlas Kubernetes Operator no modificará las configuraciones de alerta del proyecto. Si creamos un proyecto, Atlas aplica las configuraciones por defecto de alertas del proyecto.

false

auditing

Objeto

La auditoría representa MongoDB Windows de mantenimiento.

false

backupCompliancePolicyRef

Objeto

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

false

cloudProviderAccessRoles

[]objeto

CloudProviderAccessRoles es una lista de Roles de acceso de proveedores de nube configurados para el Proyecto actual. Obsoleto: Esta configuración se desaprobó en favor de CloudProviderIntegrations

false

cloudProviderIntegrations

[]objeto

CloudProviderIntegrations es una lista de Integración de Proveedor de Nube configurada para el Proyecto actual.

false

connectionSecretRef

Objeto

ConnectionSecret es el nombre del secreto de Kubernetes que contiene la información sobre la manera de conectarse a Atlas (organización ID, claves API). Se usará la configuración de conexión del operador por defecto si no se proporciona.

false

customRoles

[]objeto

CustomRoles le permite crear y cambiar funciones personalizadas en su clúster. Use roles personalizados para especificar conjuntos personalizados de acciones que los roles incorporados de Atlas no pueden describir. Obsoleto: Migra al recurso personalizado AtlasCustomRoles 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-ak8so-migrate-ptr

false

encryptionAtRest

Objeto

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

false

integrations

[]objeto

Integrations es una lista de MongoDB Atlas integrations para el proyecto. Obsoleto: para la migración debes migrarte al AtlasThirdPartyIntegration recurso personalizado conforme a 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

maintenanceWindow

Objeto

MaintenanceWindow permite especificar un momento preferido en la semana para ejecutar operaciones de mantenimiento. Ver 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: migra a los recursos personalizados AtlasNetworkPeering y AtlasNetworkContainer 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-ak8so-migrate-ptr

false

privateEndpoints

[]objeto

PrivateEndpoints es una lista de nodos privados configurados para el Proyecto actual. Obsoleto: Migrar al recurso personalizado AtlasPrivateEndpoint 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

projectIpAccessList

[]objeto

ProjectIPAccessList permite el uso de la Lista de Acceso IP para un Proyecto. Consulta más información en https://mongodb.com/es/docs/atlas/reference/api/ip-access-list/add-entries-to-access-list/ Obsoleto: migre al AtlasIPAccessList Recurso personalizado 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-ak8so-migrate-ptr

false

regionUsageRestrictions

enum

RegionUsageRestrictions designe la región AWS del proyecto cuando utilice Atlas para el Gobierno. Este parámetro no debe usarse con Atlas comercial. En Atlas for Government, si no se configura este campo (valor por defecto NONE), el proyecto estará restringido a COMMERCIAL_FEDRAMP_REGIONS_ONLY. Enum: NONE, GOV_REGIONS_ONLY, COMMERCIAL_FEDRAMP_REGIONS_ONLY por defecto: NONE

false

settings

Objeto

Configuración permite la configuración de los Ajustes del Proyecto.

false

teams

[]objeto

Los equipos permiten conceder roles de acceso a proyectos a varios usuarios.

false

withDefaultAlertsSettings

booleano

Bandera que indica si Atlas Kubernetes Operator crea un proyecto con las configuraciones de alerta por defecto. Si se utiliza este ajuste, también se debe configurar spec.``alertConfigurationSyncEnabled`` como verdadero para que el Atlas Kubernetes Operator pueda modificar las configuraciones de alertas del proyecto. Si configuras este parámetro como falso al crear un proyecto, Atlas no añade las configuraciones de alertas por defecto al proyecto. Esta configuración no tiene ningún efecto en los proyectos existentes. Por defecto: verdadero

false

x509CertRef

Objeto

X509CertRef es una referencia al secreto de Kubernetes que contiene el certificado CA codificado en PEM. Atlas Kubernetes Operator solo monitorea secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar ver secretos innecesarios.

false

AtlasProject.spec.alertConfigurations

Name
Tipo
Descripción
Requerido

enabled

booleano

Si se omite, la configuración se desactivará.

false

eventTypeName

string

El tipo de evento que activará una alerta.

false

matchers

[]objeto

Puede filtrar utilizando solo el arreglo matchers cuando el EventTypeName especifica un evento para un host, set de réplicas o clúster.

false

metricThreshold

Objeto

MetricThreshold provoca que se active una alerta.

false

notifications

[]objeto

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

false

severityOverride

enum

SeverityOverride opcionalmente anula el nivel de gravedad por defecto de una alerta. Enum: INFO, WARNING, ERROR, CRITICAL

false

threshold

Objeto

El umbral provoca 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 con el que hacer 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 provoca que se active una alerta.

Name
Tipo
Descripción
Requerido

threshold

string

Tiempo límite fuera del cual se activará una alerta.

true

metricName

string

Nombre de la métrica a verificar.

false

mode

string

Esto debe establecerse en AVERAGE. Atlas calcula el valor actual de la métrica como un promedio.

false

operator

string

Operador que se aplica al comparar el valor de la métrica actual con el valor umbral.

false

units

string

El units para el valor del umbral.

false

AtlasProject.spec.alertConfigurations.notificaciones

Name
Tipo
Descripción
Requerido

apiTokenRef

Objeto

Secreto que contiene un token API de Slack o token de Bot. Rellenado para el tipo de notificación SLACK. Si posteriormente el token se vuelve inválido, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve el token.

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 tablero de Datadog. Completo para el tipo de notificaciones DATADOG.

false

datadogRegion

string

Región que indica qué API URL utilizar.

false

delayMin

entero

Número de minutos de espera tras detectarse 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 alertas. Completado para el tipo de notificaciones EMAIL.

false

emailEnabled

booleano

Indicador que determina si se deben enviar notificaciones por correo electrónico. Repoblado para los tipos de notificaciones ORG, GROUP y USER.

false

flowName

string

Nombre de flow de Flowdock en minúsculas.

false

flowdockApiTokenRef

Objeto

El token API personal de Flowdock. Completado para el tipo de notificaciones FLOWDOCK. Si el token posteriormente se vuelve inválido, Atlas envía un email al propietario del proyecto y finalmente remueve el token.

false

intervalMin

entero

Número de minutos que deben transcurrir entre notificaciones sucesivas sobre alertas no reconocidas que no se hayan resuelto.

false

mobileNumber

string

Número móvil al que se envían notificaciones de alerta. Poblado para el tipo de notificaciones SMS .

false

opsGenieApiKeyRef

Objeto

OpsGenie API Clave. Se llena para el tipo de notificación OPS_GENIE. Si la clave llegara a volverse inválida, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve el token.

false

opsGenieRegion

string

Región que indica qué API URL utilizar.

false

orgName

string

Nombre de la organización Flowdock en letras minúsculas. Este es el nombre que aparece después de www.flowdock.com/app/ en la string URL. Ingresado para el tipo de notificación FLOWDOCK.

false

roles

[]string

Las 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

Indicador que muestra si se deben enviar notificaciones por mensajes de texto. Poblado para ORG, GROUP y USER tipos de notificaciones.

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 Atlas user al que se le deben enviar las notificaciones. Solo un usuario en el proyecto que posee la configuración de alertas puede hacerlo aquí. Completado para el tipo de notificaciones 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 la API de Slack o un token de Bot. Se pobló para el tipo de notificaciones de SLACK. Si posteriormente el token se vuelve inválido, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve el token.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.datadogAPIKeyRef

Secreto que contiene una clave de la API de Datadog. Se encuentra en el tablero de DataDog. Rellenado para el tipo de notificaciones de DATADOG.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.flowdockApiTokenRef

El token personal de la API de Flowdock. Poblado para el tipo de notificaciones FLOWDOCK. Si posteriormente el token se vuelve inválido, Atlas envía un correo electrónico al propietario del proyecto y finalmente remueve el token.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.opsGenieApiKeyRef

Clave API de OpsGenie. Rellenado para el tipo de notificaciones OPS_GENIE. Si la clave se vuelve inválida más adelante, Atlas envía un correo electrónico al propietario del proyecto y eventualmente remueve el token.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notificaciones.serviceKeyRef

Clave de servicio de PagerDuty. Se completó para el tipo de notificación PAGER_DUTY. Si posteriormente la clave se vuelve inválida, Atlas envía un correo electrónico al propietario del proyecto y, eventualmente, remueve la clave.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.notifications.victorOpsSecretRef

Secreto que contiene una clave API de VictorOps y una clave de enrutamiento. Se rellena para el tipo de notificaciones VICTOR_OPS. Si la clave se invalida posteriormente, Atlas enviará un correo electrónico al propietario del proyecto y, finalmente, removerá la clave.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.alertConfigurations.threshold

El umbral provoca que se active una alerta.

Name
Tipo
Descripción
Requerido

operator

string

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

false

threshold

string

Tiempo límite fuera del cual se activará una alerta.

false

units

string

El units para el valor del umbral.

false

AtlasProject.spec.auditing

Auditing representa las Windows de mantenimiento de MongoDB.

Name
Tipo
Descripción
Requerido

auditAuthorizationSuccess

booleano

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

false

auditFilter

string

JSON-filtro de auditoría formateado usado por el proyecto.

false

enabled

booleano

Indica si el proyecto asociado con el {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 copias de seguridad.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace 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 IAM rol que asume el clúster de 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 IAM rol que asume el clúster de Atlas.

false

AtlasProject.spec.connectionSecretRef

ConnectionSecret es el nombre del Secreto de Kubernetes que contiene la información sobre la forma de conectarse a Atlas (Identificador de la Organización, claves API). Se usará la configuración por defecto de conexión del Operador si no se proporciona una alternativa.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.customRoles

CustomRole permite crear y modificar un rol personalizado en tu clúster. Utiliza roles personalizados para especificar conjuntos personalizados de acciones que los roles integrados de Atlas no pueden describir. Obsoleto: migrar al recurso personalizado AtlasCustomRoles 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-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible por humanos 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 este rol personalizado hereda.

false

AtlasProject.spec.customRoles.acciones

Name
Tipo
Descripción
Requerido

name

string

Etiqueta legible por humanos que identifica la acción de privilegio.

true

resources

[]objeto

Lista de resources en los que otorgas la acción.

true

AtlasProject.spec.customRoles.acciones.recursos

Name
Tipo
Descripción
Requerido

cluster

booleano

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

false

collection

string

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

false

database

string

Etiqueta legible por humanos que identifica el database al que se concede 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 establecer el cifrado para los proveedores de AWS, Azure y GCP.

Name
Tipo
Descripción
Requerido

awsKms

Objeto

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

false

azureKeyVault

Objeto

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

false

googleCloudKms

Objeto

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

false

AtlasProject.spec.encryptionAtRest.awsKms

AwsKms especifica los detalles de la configuración de AWS KMS y si el cifrado en reposo está habilitado para un proyecto de 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 llave maestra de cliente AWS.

false

secretRef

Objeto

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

false

valid

booleano

Especifica si el conjunto de claves de cifrado para el proveedor es valid y se puede utilizar para cifrar y descifrar datos.

false

AtlasProject.spec.encryptionAtRest.awsKms.secretRef

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

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.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 de 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 al tenant 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 secreto SubscriptionID, KeyVaultName, KeyIdentifier.

false

tenantID

string

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

false

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

namespace del recurso de Kubernetes

false

AtlasProject.spec.encryptionAtRest.googleCloudKms

GoogleCloudKms especifica los detalles de configuración de GCP KMS y si el cifrado en reposo está activado para un proyecto de 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

AtlasProject.spec.encryptionAtRest.googleCloudKms.secretRef

Una referencia a Secret que contiene los campos ServiceAccountKey y KeyVersionResourceID

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.integra suecciones

Integración para el proyecto entre Atlas y un servicio externo. Obsoleto: migre al recurso personalizado AtlasThirdPartyIntegration siguiendo 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

Name
Tipo
Descripción
Requerido

accountId

string

string única de dígitos hexadecimales 40que identifica tu cuenta de New Relic.

false

apiKeyRef

Objeto

Referencia a un Secreto de Kubernetes que contiene tu 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 tu cuenta de Slack.

false

channelName

string

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

false

enabled

booleano

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

false

flowName

string

DEPRECATEDNombre del flujo de Flowdock. Este campo ha sido retirado de Atlas y no tiene ningún efecto.

false

licenseKeyRef

Objeto

Referencia a un secreto de Kubernetes que contiene tu única 40-hexadecimal digit string que identifica tu licencia de New Relic.

false

microsoftTeamsWebhookUrl

string

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

false

name

string

false

orgName

string

DEPRECATEDNombre de la organización en Flowdock. Este campo ha sido eliminado de Atlas y no tiene ningún efecto.

false

passwordRef

Objeto

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

false

readTokenRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave de query asociada a tu cuenta de New Relic.

false

region

string

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

false

routingKeyRef

Objeto

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

false

scheme

string

false

secretRef

Objeto

Referencia a un secreto de Kubernetes que contiene la clave secreta para tu Webhook.

false

serviceDiscovery

string

Método deseado para descubrir el servicio de Prometheus.

false

serviceKeyRef

Objeto

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

false

teamName

string

Etiqueta legible por humanos que identifica a tu equipo Slack.

false

type

enum

Integración de terceros type como Slack, New Relic, etc. Cada integración type requiere un conjunto distinto de campos de configuración. Por ejemplo, si configura type en DATADOG, debe configurar únicamente los subcampos de datadog. Enumeración: PAGER_DUTY, SLACK, DATADOG, NEW_RELIC, OPS_GENIE, VICTOR_OPS, FLOWDOCK, WEBHOOK, MICROSOFT_TEAMS, PROMETHEUS

false

url

string

Dirección web del punto final a la que Atlas envía notificaciones. Usados para Webhooks.

false

username

string

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

false

writeTokenRef

Objeto

Referencia a un secreto de Kubernetes que contenga la clave de inserción asociada con tu 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

namespace 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 tu cuenta de Slack.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.integrations.licenseKeyRef

Referencia a un secreto de Kubernetes que contiene tu única 40-hexadecimal digit string que identifica tu licencia de New Relic.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace 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 tu cuenta de Prometheus.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.integrations.readTokenRef

Referencia a un secreto de Kubernetes que contiene la clave de query asociada a tu cuenta de New Relic.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.integrations.routingKeyRef

Referencia a un secreto de Kubernetes que contiene la clave de enrutamiento asociada a tu 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

namespace del recurso de Kubernetes

false

AtlasProject.spec.integrations.secretRef

Referencia a un secreto de Kubernetes que contiene la clave secreta para tu Webhook.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.integrations.serviceKeyRef

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

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.especificación.integraciones.refDeTokenDeEscritura

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

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.spec.maintenanceWindow

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

Name
Tipo
Descripción
Requerido

autoDefer

booleano

Indicador que señala si el mantenimiento programado de algún proyecto debe posponerse automáticamente durante 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

Indicador que señala si el siguiente mantenimiento programado del proyecto debe aplazarse una semana. No se puede especificar si startASAP es verdadero

false

hourOfDay

entero

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

false

startASAP

booleano

Indicador de si se ha instruido que las labores de mantenimiento del proyecto comiencen de inmediato. No se puede especificar si defer es verdadero

false

AtlasProject.spec.networkPeers

NetworkPeer configurado para el proyecto actual. Obsoleto: migrar a los recursos personalizados AtlasNetworkPeering y AtlasNetworkContainer 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-ak8so-migrate-ptr

Name
Tipo
Descripción
Requerido

accepterRegionName

string

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

false

atlasCidrBlock

string

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

false

awsAccountId

string

AccountID del VPC del usuario.

false

azureDirectoryId

string

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

false

azureSubscriptionId

string

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

false

containerId

string

ID del contenedor peer de la red. Si no está configurado, el operador creará un nuevo contenedor con entrada ContainerRegion y AtlasCIDRBlock.

false

containerRegion

string

ContainerRegion es el nombre de la región del proveedor del contenedor de Atlas network emparejamiento. Si no se establece, se utiliza AccepterRegionName.

false

gcpProjectId

string

Usuario GCP Proyecto ID. Solo es aplicable para GCP.

false

networkName

string

GCP Nombre del par en la red. Su aplicabilidad es válida únicamente para GCP.

false

providerName

string

ProviderName es el nombre del proveedor. Si no se establece, se configurará como "AWS".

false

resourceGroupName

string

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

false

routeTableCidrBlock

string

Usuario VPC CIDR.

false

vnetName

string

VNetName es el nombre de tu Azure VNet. Es aplicable solo para Azure.

false

vpcId

string

AWS VPC ID.

false

AtlasProject.spec.privateEndpoints

PrivateEndpoint es una lista de nodos privados configurados para el Proyecto actual. Obsoleto: migre al recurso personalizado AtlasPrivateEndpoint 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-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 cual deseas crear el servicio de punto final privado.

true

endpointGroupName

string

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

false

endpoints

[]objeto

Colección de endpoints privadas individuales que conforman su grupo de endpoints.

false

gcpProjectId

string

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

false

id

string

Identificador único del punto final privado creado en tu AWS VPC o en la red VNet de Azure.

false

ip

string

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

false

AtlasProject.spec.privateEndpoints.endpoints

Name
Tipo
Descripción
Requerido

endpointName

string

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

false

ipAddress

string

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

false

AtlasProject.spec.projectIpAccessList

IPAccessList permite el uso de 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 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-ak8so-migrate-ptr

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 direcciones IP en notación CIDR en este elemento de la lista de acceso.

false

comment

string

Comentario asociado con esta entrada en la lista de acceso.

false

deleteAfterDate

string

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC después de lo 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

Indicador 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 activar el Explorador de datos para el proyecto especificado.

false

isExtendedStorageSizesEnabled

booleano

Indicador que indica si se deben activar tamaños de almacenamiento ampliados para el proyecto especificado.

false

isPerformanceAdvisorEnabled

booleano

Indicador que señala si se debe habilitar el Performance Advisor y el perfilador para el proyecto especificado.

false

isRealtimePerformancePanelEnabled

booleano

Indicador que indica si se debe habilitar el Panel de Rendimiento en Tiempo Real para el proyecto especificado.

false

isSchemaAdvisorEnabled

booleano

Indicador que indica si se debe activar el Asesor de Esquemas para el proyecto especificado.

false

AtlasProject.spec.teams

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

AtlasProject.spec.teams.teamRef

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

namespace del recurso de Kubernetes

false

AtlasProject.spec.x509CertRef

X509CertRef es una referencia al secreto de Kubernetes que contiene el certificado CA codificado en PEM. Atlas Kubernetes Operator solo monitorea secretos con la etiqueta atlas.mongodb.com/type=credentials para evitar ver secretos innecesarios.

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

AtlasProject.status

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 Atlas

true

alertConfigurations

[]objeto

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

false

authModes

[]string

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

false

cloudProviderIntegrations

[]objeto

CloudProviderIntegrations contiene una lista de roles de acceso de proveedor de nube configurados. Soporte solo para AWS

false

customRoles

[]objeto

CustomRoles contiene una lista de estados de roles personalizados

false

expiredIpAccessList

[]objeto

La lista de entradas de la lista de acceso de IP que han expirado porque 'deleteAfterDate' es menor que la fecha actual. Ten en cuenta que este campo es actualizado por el operador de Atlas solo después de los cambios en las especificaciones.

false

id

string

El ID del Proyecto Atlas

false

networkPeers

[]objeto

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

false

observedGeneration

entero

ObservedGeneration indica la generación de la especificación del recurso de la que el operador Atlas tiene conocimiento. El operador de Atlas actualiza este campo al valor de 'metadatos.generation' tan pronto como comience la conciliación del recurso. Formato: int64

false

privateEndpoints

[]objeto

La lista de nodos privados configurados para el Proyecto actual

false

prometheus

Objeto

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

false

teams

[]objeto

Teams contiene una lista de estados de asignación teams

false

AtlasProject.status.conditions

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 recursos personalizados de Atlas.

true

lastTransitionTime

string

La última vez, la condición pasó de un estado a otro. Representado en formato ISO 8601. Formato: fecha-hora

false

message

string

Un message que proporciona detalles sobre la transición.

false

reason

string

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

false

AtlasProject.status.alertConfigurations

Name
Tipo
Descripción
Requerido

acknowledgedUntil

string

La fecha hasta la cual se ha reconocido la alerta. No estará presente si la alerta nunca ha sido reconocida.

false

acknowledgementComment

string

El comentario dejado por el usuario que reconoció la alerta. No estará presente si la alerta nunca ha sido reconocida.

false

acknowledgingUsername

string

El nombre de usuario de la persona que reconoció la alerta. No estará presente si la alerta nunca ha sido reconocida.

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. Presente sólo 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

Fecha y hora en ISO 8601 formato de fecha y hora 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 presente para alertas de tipo HOST_METRIC.

false

enabled

booleano

Si se omite, la configuración se desactivará.

false

errorMessage

string

ErrorMessage si el examen de alerta está en 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 presenta en alertas de tipo HOST, HOST_METRIC y REPLICA_SET.

false

hostnameAndPort

string

El nombre del host y el puerto de cada host al que se aplica la alerta. Solo presenta en alertas de tipo HOST, HOST_METRIC y REPLICA_SET.

false

id

string

Unique identifier.

false

lastNotified

string

Cuando se envió la última notificación para esta alerta. Solo se presenta si se han enviado notificaciones.

false

matchers

[]objeto

Puede filtrar utilizando solo el arreglo matchers cuando el EventTypeName especifica un evento para un host, set de réplicas o clúster.

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

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

false

replicaSetName

string

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

false

resolved

string

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

false

severityOverride

string

Gravedad de la alerta.

false

sourceTypeName

string

Para alertas de tipo BACKUP, el tipo de servidor que se está respaldando.

false

status

string

El estado actual de la alerta. Los posibles valores son: TRACKING, OPEN, CLOSED, CANCELED

false

threshold

Objeto

El umbral provoca que se active una alerta.

false

updated

string

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

false

AtlasProject.status.alertConfigurations.currentValue

CurrentValue representa el valor actual de la métrica que activó la alerta. Presente solo para 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 con el que hacer 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 provoca que se active una alerta.

Name
Tipo
Descripción
Requerido

threshold

string

Tiempo límite fuera del cual se activará una alerta.

true

metricName

string

Nombre de la métrica a verificar.

false

mode

string

Esto debe establecerse en AVERAGE. Atlas calcula el valor actual de la métrica como un promedio.

false

operator

string

Operador que se aplica al comparar el valor de la métrica actual con el valor umbral.

false

units

string

El units para el valor del 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 cuál API URL usar

false

delayMin

entero

Número de minutos de espera tras detectarse 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 alertas. Completado para el tipo de notificaciones EMAIL.

false

emailEnabled

booleano

Indicador que determina si se deben enviar notificaciones por correo electrónico. Repoblado para los tipos de notificaciones ORG, GROUP y USER.

false

flowName

string

Nombre Flowdock flow en minúsculas.

false

flowdockApiToken

string

El token API personal de Flowdock. Completado para el tipo de notificaciones FLOWDOCK. Si el token posteriormente se vuelve inválido, Atlas envía un email al propietario del proyecto y finalmente remueve el token.

false

intervalMin

entero

Número de minutos que deben transcurrir entre notificaciones sucesivas sobre alertas no reconocidas que no se hayan resuelto.

false

mobileNumber

string

Número móvil al que se envían notificaciones de alerta. Poblado para el tipo de notificaciones SMS .

false

opsGenieApiKey

string

Clave de Opsgenie API. Completado para el tipo de notificaciones OPS_GENIE. Si la clave posteriormente se vuelve inválida, Atlas envía un correo electrónico al propietario del proyecto y eventualmente remueve el token.

false

opsGenieRegion

string

Región que indica qué API URL utilizar.

false

orgName

string

Nombre de la organización Flowdock en letras minúsculas. Este es el nombre que aparece después de www.flowdock.com/app/ en la string URL. Ingresado para el tipo de notificación FLOWDOCK.

false

roles

[]string

Las 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

Indicador que muestra si se deben enviar notificaciones por mensajes de texto. Poblado para ORG, GROUP y USER tipos de notificaciones.

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 Atlas user al que se le deben enviar las notificaciones. Solo un usuario en el proyecto que posee la configuración de alertas puede hacerlo aquí. Completado para el tipo de notificaciones USER.

false

victorOpsApiKey

string

VictorOps API clave. Se completa para el VICTOR_OPS tipo de notificaciones. Si la clave posteriormente se vuelve inválida, Atlas envía un correo electrónico al propietario del Proyecto y, eventualmente, remueve la clave.

false

victorOpsRoutingKey

string

VictorOps clave de enrutamiento. Se completa para el VICTOR_OPS tipo de notificaciones. Si la clave posteriormente se vuelve inválida, Atlas envía un correo electrónico al propietario del Proyecto y, eventualmente, remueve la clave.

false

AtlasProject.status.alertConfigurations.threshold

El umbral provoca 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

Tiempo límite fuera del cual se activará una alerta.

false

units

string

El units para el valor umbral

false

AtlasProject.status.cloudProviderIntegrations

Name
Tipo
Descripción
Requerido

atlasAssumedRoleExternalId

string

Externo único ID que MongoDB Atlas utiliza cuando asume el rol IAM en tu 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 Gestió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 se 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

Identificador de recurso de Amazon que identifica el rol de Amazon Web Services Identity and Access Management que MongoDB nube asume al acceder a recursos en su cuenta de AWS.

false

roleId

string

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

false

status

string

Provisión 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

Identificando las características sobre el lago de datos vinculado a este rol de Gestión de identidades y accesos de Amazon Web Services.

false

featureType

string

etiqueta legible por humanos que describe una MongoDB funcionalidad de la nube vinculada al rol de Amazon Web Services Identity and Access Management.

false

AtlasProject.status.customRoles

Name
Tipo
Descripción
Requerido

name

string

El rol name 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 el uso de 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 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-ak8so-migrate-ptr

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 direcciones IP en notación CIDR en este elemento de la lista de acceso.

false

comment

string

Comentario asociado con esta entrada en la lista de acceso.

false

deleteAfterDate

string

Marca de tiempo en ISO 8601 formato de fecha y hora en UTC después de lo 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 deseas crear el par de red. No es necesario para GCP

true

atlasGcpProjectId

string

ProjectID del contenedor Atlas. Aplicable solo a GCP. Es necesario agregar una conexión entre pares en la red.

false

atlasNetworkName

string

Nombre de la Red Atlas. Aplicable solo a GCP. Es necesario agregar una conexión entre pares en la red.

false

connectionId

string

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

false

containerId

string

ContainerID del contenedor de pares de la red Atlas.

false

errorMessage

string

Estado de error del par de red. Aplicable sólo 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 red. Aplicable sólo para AWS.

false

gcpProjectId

string

ProjectID de vpc del usuario. Aplica solo para GCP.

false

status

string

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

false

statusName

string

Estado del par de la red. Aplicable sólo para AWS.

false

vpc

string

VPC es un campo de uso general para almacenar el nombre de la 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 el que desea recuperar un servicio de endpoint privado. Atlas acepta AWS o AZURE.

true

region

string

Proveedor de nube region para el cual deseas crear el servicio de punto final privado.

true

endpoints

[]objeto

Colección de GCP individuales privados endpoints 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

[]string

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 servicio de Azure Private Link que Atlas gestiona.

false

serviceResourceId

string

Identificador único del Servicio de Azure Private Link (para AWS el 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 creaste.

true

ipAddress

string

Una dirección del Protocolo de Internet privado versión 4 (IPv4) a 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, incluyendo el prometheusDiscoveryURL

Name
Tipo
Descripción
Requerido

prometheusDiscoveryURL

string

URL de los cuales Prometheus obtiene los objetivos.

false

scheme

string

Protocolo scheme utilizado para las 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 namespace

true

id

string

false

AtlasProject.status.teams.teamRef

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

Name
Tipo
Descripción
Requerido

name

string

Nombre del recurso de Kubernetes

true

namespace

string

namespace del recurso de Kubernetes

false

Volver

Recursos personalizados

Next

AtlasDeployment

En esta página