El recurso personalizado AtlasDeployment configura su clúster de MongoDB o instancia sin servidor en Atlas. Al crear el recurso personalizado AtlasDeployment, el operador de Kubernetes de Atlas intenta crear o actualizar un clúster o una instancia sin servidor en Atlas.
Importante
Las definiciones de recursos personalizados tienen prioridad
El operador de Kubernetes de Atlas utiliza Archivos de configuración derecursos personalizados para administrar la configuración de Atlas. Cada definición de recurso personalizado anula la configuración especificada de otras maneras, como en la interfaz de usuario de Atlas. Si elimina un recurso personalizado, Atlas Kubernetes Operator elimina el objeto de Atlas a menos que utilice anotaciones para omitir la eliminación. Para obtener más información, consulte los procesos de creación y actualización y de eliminación.
El operador Atlas Kubernetes realiza una de las siguientes acciones según los valores que especifique en el recurso personalizado AtlasDeployment:
Si especifica valores para los campos
spec.deploymentSpecen, Atlas Kubernetes Operator utiliza el recurso de API de clústeres de Atlas y el recurso de API de clústeres avanzados para crear un nuevo clúster o actualizar uno existente.Si especifica valores para los campos
spec.serverlessSpecen, Atlas Kubernetes Operator utiliza el recurso de API de instancia sin servidor de Atlas para crear una nueva instancia sin servidor o actualizar una instancia sin servidor existente.
La creación de un clúster Atlas de nivel gratuito lleva menos de 15 segundos.
Crear o actualizar un clúster Flex o un clúster Dedicado puede tardar hasta 10 minutos. Atlas Kubernetes Operator supervisa el proceso de actualización.
Puede ejecutar el siguiente comando para comprobar el estado:
kubectl get atlasdeployment -o yaml
El siguiente ejemplo muestra la sección de estado de un clúster que se está aprovisionando:
status: conditions: - lastTransitionTime: "2021-03-18T16:32:43Z" status: "False" type: ClusterReady reason: ClusterCreating message: Cluster is provisioning
El estado ClusterReady cambiará a True cuando el clúster o la instancia sin servidor estén listos.
Si elimina el recurso AtlasDeployment de su clúster de Kubernetes, Atlas Kubernetes Operator elimina el clúster o la instancia sin servidor de Atlas.
Ejemplos
Ejemplo de estado
El siguiente ejemplo muestra el recurso AtlasDeployment con un estado ClusterReady de True:
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster namespace: default labels: app.kubernetes.io/version: 1.6.0 spec: projectRef: name: my-project deploymentSpec: name: test-cluster tags: - key: "environment", value: "production" providerSettings: instanceSizeName: M10 providerName: AWS regionName: US_EAST_1 mongoDBMajorVersion: "4.4" status: conditions: - lastTransitionTime: "2021-03-18T16:32:43Z" status: "True" type: Ready - lastTransitionTime: "2021-03-18T16:32:43Z" status: "True" type: ClusterReady connectionStrings: standard: mongodb://test-cluster-shard-00-00.kpc8f.mongodb.net:27017,test-cluster-shard-00-01.kpc8f.mongodb.net:27017,test-cluster-shard-00-02.kpc8f.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-1gm1pv-shard-0 standardSrv: mongodb+srv://test-cluster.kpc8f.mongodb.net mongoDBVersion: 4.4.4 mongoURIUpdated: "2021-03-12T12:21:41Z" observedGeneration: 1 stateName: IDLE
Ejemplo de configuración
El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para escalar automáticamente clústeres multirregionales:
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment name: test-cluster-name namespace: mongodb-atlas-system spec: projectRef: name: development deploymentSpec: autoScaling: compute: enabled: true scaleDownEnabled: true clusterType: REPLICASET name: service-name tags: - key: "environment", value: "production" providerBackupEnabled: true providerSettings: autoScaling: compute: maxInstanceSize: M40 minInstanceSize: M30 instanceSizeName: M30 providerName: GCP replicationSpecs: - numShards: 1 regionsConfig: EASTERN_US: analyticsNodes: 0 electableNodes: 1 priority: 6 readOnlyNodes: 0 SOUTH_AMERICA_EAST_1: analyticsNodes: 0 electableNodes: 2 priority: 7 readOnlyNodes: 0 zoneName: Zone 1
Ejemplo de opciones avanzadas
El siguiente ejemplo muestra una AtlasDeployment especificación de recurso personalizada configurada con opciones avanzadas.
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster labels: app.kubernetes.io/version: 1.6.0 spec: projectRef: name: my-project deploymentSpec: name: Test-cluster tags: - key: "environment", value: "production" providerSettings: instanceSizeName: M10 providerName: AWS regionName: US_EAST_1 processArgs: javascriptEnabled: false
Ejemplo de instancia sin servidor
El siguiente ejemplo muestra una especificación de recurso personalizada AtlasDeployment configurada para una instancia sin servidor:
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: test-cluster-name namespace: mongodb-atlas-system labels: app.kubernetes.io/version: 1.6.0 spec: projectRef: name: development serverlessSpec: name: serverless-instance tags: - key: "environment", value: "production" providerSettings: providerName: AWS regionName: US_EAST_1
Ejemplo de clúster avanzado
Los clústeres avanzados pueden abarcar regiones y proveedores de servicios en la nube. Para obtener más información, consulte Consideraciones sobre clústeres avanzados.
Nota
Mientras que el recurso API de clústeres avanzados de Atlas envía solicitudes mediante el v1.5 Atlas Versiones de la API: el campo Operador de Atlas Kubernetes apiVersion v1usa. En este caso, v1 se refiere a la versión de la API de Kubernetes.
El siguiente ejemplo muestra una especificación de recurso personalizado AtlasDeployment avanzado configurado para clústeres multirregionales:
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster labels: app.kubernetes.io/version: 1.6.0 spec: projectRef: name: my-project advancedDeploymentSpec: clusterType: REPLICASET name: tenantCluster tags: - key: "environment", value: "production" replicationSpecs: - regionConfigs: - electableSpecs: instanceSize: M5 providerName: AWS regionName: US_EAST_1
Ejemplo de múltiples proveedores de servicios en la nube
El siguiente ejemplo muestra una especificación de recurso personalizado AtlasDeployment avanzado configurado para abarcar múltiples proveedores de servicios en la nube:
apiVersion: atlas.mongodb.com/v1 kind: AtlasDeployment metadata: name: my-atlas-cluster labels: app.kubernetes.io/version: 1.6.0 spec: projectRef: name: my-project advancedDeploymentSpec: clusterType: REPLICASET name: tenantCluster tags: - key: "environment", value: "production" replicationSpecs: - regionConfigs: - electableSpecs: instanceSize: M10 nodeCount: 3 providerName: AWS regionName: US_EAST_1 priority: 7 - electableSpecs: instanceSize: M10 nodeCount: 2 providerName: AZURE regionName: US_EAST_2 priority: 6 - electableSpecs: instanceSize: M10 nodeCount: 2 providerName: GCP regionName: CENTRAL_US priority: 5
Parámetros
Esta sección describe algunos de los parámetros AtlasDeployment clave de recursos personalizados disponibles. Para obtener una lista completa de los parámetros disponibles para clústeres, consulte la API de clústeres de Atlas y la API de clústeres avanzadosde Atlas. Para obtener una lista completa de los parámetros disponibles para instancias sin servidor, consulte la API de instancias sin servidor de Atlas.
Consulte estas descripciones, los ejemplos disponibles y la documentación de API para personalizar sus especificaciones.
spec.advancedDeploymentSpecTipo: arreglo
Condicional
Lista que contiene los parámetros avanzados del clúster provenientes de la API. Para obtener una lista completa de los parámetros disponibles, ver la API de clústeres avanzados de Atlas.
Importante
Debe especificar
spec.deploymentSpec,spec.advancedDeploymentSpecospec.serverlessSpecen su configuración.
spec.advancedDeploymentSpec.customZoneMappingTipo: arreglo
Requerido
Lista que contiene parámetros de clúster global que asignan zonas a regiones geográficas. Para obtener una lista completa de los parámetros disponibles, consulte la API de clústeres globales de Atlas.
spec.advancedDeploymentSpec.customZoneMapping.locationTipo: string
Requerido
Código que representa una ubicación que se asigna a una zona de su clúster global.
spec.advancedDeploymentSpec.customZoneMapping.zoneTipo: string
Requerido
Etiqueta legible por humanos que identifica la zona en su clúster global.
spec.advancedDeploymentSpec.diskSizeGBTipo: número
Opcional
Capacidad, en gigabytes, que indica el volumen raíz del host. Aumente este número para añadir capacidad, hasta un valor máximo posible de
4096(es decir, 4 TB). Debe especificar un número positivo para este valor.No se puede establecer este valor con clústeres con SSD NVMe locales.
Nota
Si tiene habilitado el escalado automático para
diskGBen alguna región, no podrá editar esta opción. Para obtener más información,spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabledconsulte.El tamaño mínimo de disco para clústeres dedicados es de 10 GB para AWS y Google Cloud. Si especifica esta configuración con un tamaño de disco menor, Atlas utilizará el valor mínimo de disco de forma predeterminada.
Si su implementación de base de datos incluye nodos de Azure, este valor debe corresponder a un tipo de disco de Azure existente (,,,,,,,,8 16326412825651210242048 4096o).
Atlas calcula los cargos de almacenamiento de manera diferente dependiendo de si elige el valor predeterminado o un valor personalizado.
Atlas tiene límites de capacidad de disco en conjuntos de réplicas individuales, que se pueden escalar hasta 4 TB para niveles de clúster superiores. Para ampliar el almacenamiento total del clúster más allá de los límites predeterminados, puede habilitar el almacenamiento extendido en la configuración del proyecto. Para permitir un mayor escalamiento en el futuro, le recomendamos habilitar la fragmentación para la expansión a largo plazo.
Si la implementación de su base de datos abarca proveedores de servicios en la nube, este valor predeterminado es el valor mínimo predeterminado de los proveedores involucrados.
Para obtener más información, consulte Capacidad de almacenamiento.
spec.advancedDeploymentSpec.managedNamespacesTipo: arreglo
Requerido
Lista que contiene información para crear un espacio de nombres administrado en un clúster global específico. Para obtener una lista completa de los parámetros disponibles, consulte la API de clústeres globales de Atlas.
spec.advancedDeploymentSpec.managedNamespaces.collectionTipo: string
Requerido
Etiqueta legible por humanos de la colección a gestionar en este Clúster Global.
spec.advancedDeploymentSpec.managedNamespaces.dbTipo: string
Requerido
Etiqueta legible por humanos de la base de datos que se administrará en este Clúster Global.
spec.advancedDeploymentSpec.managedNamespaces.isCustomShardKeyHashedTipo: booleano
Opcional
Indicador que indica si se debe aplicar un hash a la clave de fragmento personalizada para la colección especificada. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara habilitar una clave de fragmento personalizada para la colección.Establézcalo en
falsepara deshabilitar una clave de fragmento personalizada para la colección. Si está deshabilitada, MongoDB usa fragmentación por rango.
Para obtener más información, consulte Claves de fragmentos con hash.
spec.advancedDeploymentSpec.managedNamespaces.isCustomShardKeyUniqueTipo: booleano
Opcional
Indicador que indica si la clave de fragmento personalizada de la colección especificada es única. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara habilitar una clave de fragmento personalizada única para la colección.Establezca en
falsepara deshabilitar una clave de fragmento personalizada única para la colección.
spec.advancedDeploymentSpec.managedNamespaces.numInitialChunksTipo: entero
Opcional
Número mínimo de fragmentos a crear inicialmente al fragmentar una colección vacía con una clave de fragmento con hash.
Para obtener más información, consulte Fragmentar una colección global.
spec.advancedDeploymentSpec.managedNamespaces.presplitHashedZonesTipo: booleano
Opcional
Indicador que indica si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o inexistente. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara que MongoDB Cloud cree y distribuya fragmentos iniciales para una colección vacía o inexistente.Establezca en
falsepara que MongoDB Cloud no cree ni distribuya fragmentos iniciales para una colección vacía o inexistente.
spec.advancedDeploymentSpec.pitEnabledTipo: booleano
Condicional
Configuración que permite la copia de seguridad continua en la nube para clústeres avanzados. Para habilitar la copia de seguridad continua en la nube, debe especificar esta configuración con el
truevalor. Para clústeres estándar,spec.deploymentSpec.pitEnabledconsulte.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigsTipo: arreglo
Requerido
Especificaciones de hardware para los nodos definidos para una región determinada. Cada objeto
regionConfigsdescribe la prioridad de la región en las elecciones, así como la cantidad y el tipo de nodos MongoDB que Atlas implementa en ella.Cada objeto
regionConfigsdebe tener un objetoanalyticsSpecs, un objetoelectableSpecso un objetoreadOnlySpecs.M0,M2, oM5` clusters require only ``electableSpecs.Los clústeres dedicados pueden especificar cualquiera de estas especificaciones, pero deben tener al menos un objeto
electableSpecsdentro de unreplicationSpec.Cada especificación de hardware debe utilizar el mismo
instanceSize.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.analyticsSpecsTipo: objeto
Opcional
Especificaciones de hardware para los nodos de análisis necesarios en la región. Los nodos de análisis gestionan datos analíticos, como consultas de informes de BI Connector for Atlas. Son de solo lectura y nunca pueden convertirse en el nodo principal.
Si no especifica este parámetro, Atlas no implementará ningún análisis en esta región.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.diskGB.enabledTipo: booleano
Opcional
Indicador que indica si esta implementación de base de datos habilita el escalado automático de discos. Este parámetro tiene el valor predeterminado
true.Establezca en
truepara habilitar el escalamiento automático del disco.Establezca en
falsepara deshabilitar el escalamiento automático del disco.
La cantidad máxima de RAM para el nivel de clúster seleccionado y el tamaño del registro de operaciones pueden limitar el escalado automático del almacenamiento. Para obtener más información, consulte Personalizar el almacenamiento.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledTipo: booleano
Opcional
Indicador que indica si el escalado automático del tamaño de la instancia está habilitado. Este parámetro tiene el valor predeterminado
false.Establezca
truepara habilitar el escalado automático del tamaño de la instancia. Si está habilitado, debe especificar un valorspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizepara.Establezca en
falsepara deshabilitar el escalamiento automático del tamaño de la instancia.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizeTipo: string
Condicional
Cadena que indica el tamaño máximo de instancia al que se puede escalar automáticamente la implementación de la base de datos (por
M40ejemplo,). Debe especificar este parámetro sispec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledestablecetrueen.Nota
Si establece un tamaño de instancia máximo menor que el tamaño de instancia actual de la implementación de la base de datos con el escalado automático habilitado, Atlas escala automáticamente el tamaño de instancia actual al valor máximo que especifique.
Por ejemplo, si el tamaño de instancia actual de la implementación de la base de datos es
M40y usted establece el tamaño máximo de instancia enM30, Atlas escala automáticamente el tamaño de instancia actual aM30.Si Atlas cambia el tamaño de la instancia actual y usted no cambia
spec.deploymentSpec.providerSettings.instanceSizeNameen Atlas Kubernetes Operator para que coincida con el nuevo tamaño de instancia, Atlas Kubernetes Operator muestra una advertencia en los registros, pero no impide el escalado automático.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSizeTipo: string
Condicional
String que indica el tamaño mínimo de instancia al que tu implementación de la base de datos puede escalar automáticamente (como
M10). Debes especificar este parámetro si configurasspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledentrue.Nota
Si establece un tamaño de instancia mínimo mayor que el tamaño de instancia actual de la implementación de la base de datos con el escalado automático habilitado, Atlas escala automáticamente el tamaño de instancia actual al valor mínimo que especifique.
Por ejemplo, si el tamaño de instancia actual de la implementación de la base de datos es
M10y usted establece el tamaño de instancia mínimo enM30, Atlas escala automáticamente el tamaño de instancia actual aM30.Si Atlas cambia el tamaño de la instancia actual y usted no cambia
spec.deploymentSpec.providerSettings.instanceSizeNameen Atlas Kubernetes Operator para que coincida con el nuevo tamaño de instancia, Atlas Kubernetes Operator muestra una advertencia en los registros, pero no impide el escalado automático.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecsTipo: objeto
Opcional
Especificaciones de hardware para nodos elegibles en la región. Los nodos elegibles pueden convertirse en el nodo principal y habilitar lecturas locales.
Si no especifica esta opción, Atlas no implementará ningún nodo elegible en la región.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecs.instanceSizeTipo: string
Condicional
Especificación de hardware para los tamaños de instancia en esta región. Cada tamaño de instancia tiene una capacidad de almacenamiento y memoria predeterminada. El tamaño de instancia que seleccione se aplica a todos los hosts que contienen datos en su tamaño de instancia. Para obtener más información, consulte los tamaños de almacenamiento personalizados de AWS, GCP y Azure.
Si implementa un clúster fragmentado o un clúster global, debe elegir un tamaño de instancia de
M30o mayor.Nota
Si tiene habilitado el escalado automático para el campo de cálculo, no podrá editar esta opción. Para obtener más información,
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.enabledconsulte.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.electableSpecs.nodeCountTipo: entero
Condicional
Número de nodos elegibles que Atlas puede implementar en la región. Los nodos elegibles pueden convertirse en los nodos principales y habilitar lecturas locales.
El total combinado de
electableSpecs.nodeCountentre todos los objetosreplicationSpecs.regionConfigsdebe sumar3,5o7.No se pueden crear nodos elegibles
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.prioritysi0es.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.priorityTipo: entero
Requerido
Se da prioridad a esta región cuando se realizan elecciones primarias.
Si su
regionConfigssolo tienereadOnlySpecs,analyticsSpecso ambos, configure este valor en0.Si tiene varios objetos
regionConfigs(su clúster es multirregión o multinube), deben tener prioridades en orden descendente. La prioridad más alta es7.Ejemplo
Establezca su región de mayor prioridad en
7, su segunda prioridad en6y su tercera prioridad en5. Si no tiene nodos elegibles, establezca este valor en0.Si su región ha establecido
electableSpecs.nodeCounten1o superior, debe tener una prioridad exactamente igual a una región menor que otra en lareplicationSpecs.regionConfigsmatriz, a menos que sea la principal. La región con mayor prioridad debe tener una prioridad7de. La prioridad más baja posible1es.La
7región de prioridad identifica la región preferida del clúster. Atlas coloca el nodo principal en la región preferida. Las prioridades1a7son excluyentes: no se puede asignar una prioridad determinada a más de una región por clúster.Ejemplo
Si tiene tres regiones, sus prioridades serían
7,6y5, respectivamente. Si añadiera dos regiones más para admitir nodos elegibles, sus prioridades serían4y3, respectivamente.
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.readOnlySpecsTipo: objeto
Opcional
Especificaciones de hardware para nodos de solo lectura en la región. Los nodos de solo lectura nunca pueden convertirse en el miembro :primary, pero pueden habilitar lecturas locales.
Si no especifica este parámetro, Atlas no implementará ningún nodo de solo lectura en la región.
spec.advancedDeploymentSpec.tagsTipo: arreglo
Opcional
Lista que contiene etiquetas (pares clave-valor) para comprender, organizar e identificar mejor las implementaciones de bases de datos. Para obtener más información, consulte Etiquetas en clústeres.
spec.backupRefTipo: objeto
Opcional
Lista que contiene los detalles del
AtlasBackupSchedulerecurso personalizado que desea aplicar. Puede especificar una programación de copia de seguridad por clúster.
spec.backupRef.nameTipo: string
Opcional
metadata.nameValor dentro del recursoAtlasBackupSchedulepersonalizado para la programación de copias de seguridad que desea aplicar. Puede especificar solo una programación de copias de seguridad por clúster, pero puede usar la misma programación para varios clústeres.Si no se especifica este parámetro, Atlas no aplicará tu configuración de copia de seguridad a este clúster.
spec.backupRef.namespaceTipo: string
Opcional
Cadena que indica el espacio de nombres que contiene el recurso
AtlasBackupSchedulepersonalizado para la programación de copia de seguridad que desea aplicar.
spec.deploymentSpecTipo: arreglo
Condicional
Lista que contiene los parámetros del clúster de la API. Para obtener una lista completa de los parámetros disponibles, consulte la API de clústeres de Atlas.
Importante
Debe especificar
spec.deploymentSpec,spec.advancedDeploymentSpecospec.serverlessSpecen su configuración.
spec.deploymentSpec.clusterTypeTipo: string
Condicional
Etiqueta legible por humanos que identifica el tipo de clúster a crear.
¿Cuándo se debe utilizar este parámetro?
CondiciónNecesidadConfigura
spec.deploymentSpec.replicationSpecs.Requerido
Estás implementando clústeres globales.
Requerido
Está implementando conjuntos de réplicas no globales y clústeres fragmentados.
Opcional
Atlas acepta:
ValorTipo de clústerRÉPLICASET
set de réplicas
FRAGUADO
clúster fragmentado
GEOSHARDED
spec.deploymentSpec.customZoneMappingTipo: arreglo
Requerido
Lista que contiene parámetros de clúster global que asignan zonas a regiones geográficas. Para obtener una lista completa de los parámetros disponibles, consulte la API de clústeres globales de Atlas.
spec.deploymentSpec.customZoneMapping.locationTipo: string
Requerido
Código que representa una ubicación que se asigna a una zona de su clúster global.
spec.deploymentSpec.customZoneMapping.zoneTipo: string
Requerido
Etiqueta legible por humanos que identifica la zona en su clúster global.
spec.deploymentSpec.encryptionAtRestProviderTipo: string
Opcional
Proveedor de servicios en la nube que administra la clave de cliente para este clúster. Debe configurar este valor para habilitar el cifrado en reposo mediante claves administradas por el cliente para este clúster, lo que proporciona una capa adicional de cifrado.
Para obtener más información,consulte Cifrar datos mediante un servicio de administración de claves.
Atlas acepta los siguientes valores:
ValorProveedor de nubeAWS
Amazon AWS
GCP
Google Cloud
AZUR
Microsoft Azure
NINGUNO
Sin proveedor; el clúster no cifra datos utilizando claves administradas por el cliente.
spec.deploymentSpec.managedNamespacesTipo: arreglo
Requerido
Lista que contiene información para crear un espacio de nombres administrado en un clúster global específico. Para obtener una lista completa de los parámetros disponibles, consulte la API de clústeres globales de Atlas.
spec.deploymentSpec.managedNamespaces.collectionTipo: string
Requerido
Etiqueta legible por humanos de la colección a gestionar en este Clúster Global.
spec.deploymentSpec.managedNamespaces.dbTipo: string
Requerido
Etiqueta legible por humanos de la base de datos que se administrará en este Clúster Global.
spec.deploymentSpec.managedNamespaces.isCustomShardKeyHashedTipo: booleano
Opcional
Indicador que indica si se debe aplicar un hash a la clave de fragmento personalizada para la colección especificada. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara habilitar una clave de fragmento personalizada para la colección.Establézcalo en
falsepara deshabilitar una clave de fragmento personalizada para la colección. Si está deshabilitada, MongoDB usa fragmentación por rango.
Para obtener más información, consulte Claves de fragmentos con hash.
spec.deploymentSpec.managedNamespaces.isCustomShardKeyUniqueTipo: booleano
Opcional
Indicador que indica si la clave de fragmento personalizada de la colección especificada es única. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara habilitar una clave de fragmento personalizada única para la colección.Establezca en
falsepara deshabilitar una clave de fragmento personalizada única para la colección.
spec.deploymentSpec.managedNamespaces.numInitialChunksTipo: entero
Opcional
Número mínimo de fragmentos a crear inicialmente al fragmentar una colección vacía con una clave de fragmento con hash.
Para obtener más información, consulte Fragmentar una colección global.
spec.deploymentSpec.managedNamespaces.presplitHashedZonesTipo: booleano
Opcional
Indicador que indica si MongoDB Cloud debe crear y distribuir fragmentos iniciales para una colección vacía o inexistente. Este parámetro tiene el valor predeterminado
false.Establezca en
truepara que MongoDB Cloud cree y distribuya fragmentos iniciales para una colección vacía o inexistente.Establezca en
falsepara que MongoDB Cloud no cree ni distribuya fragmentos iniciales para una colección vacía o inexistente.
spec.deploymentSpec.mongoDBMajorVersionTipo: string
Opcional
Versión del clúster que se va a implementar. Atlas admite las siguientes versiones de MongoDB para los clústeres
M10+:4.4
5.0
6.0
7.0
8.0
Las siguientes condiciones producen los siguientes resultados:
CondiciónResultadoOmite este parámetro y omite el
spec.deploymentSpec.versionReleaseSystemparámetro.Atlas implementa un clúster que ejecuta MongoDB 6.0.
Omite este parámetro y establece el
spec.deploymentSpec.versionReleaseSystemparámetroLTSen.Atlas implementa un clúster que ejecuta MongoDB 6.0.
Establece el
spec.deploymentSpec.providerSettings.instanceSizeNameparámetroM0en,M2M5o.Debe implementar MongoDB 6.0.
Usted especifica este parámetro.
Atlas siempre implementa el clúster con la última versión del parche estable de la versión especificada.
Establece el parámetro
spec.deploymentSpec.versionReleaseSystemen.CONTINUOUSDebes omitir este parámetro.
spec.deploymentSpec.pitEnabledTipo: booleano
Condicional
Configuración que permite la copia de seguridad continua en la nube. Para habilitarla, debe especificar esta configuración con el
truevalor. Para clústeres avanzados,spec.advancedDeploymentSpec.pitEnabledconsulte.
spec.deploymentSpec.providerSettingsTipo: Objeto
Condicional
Configuración que especifica la configuración de los hosts aprovisionados donde se ejecuta MongoDB. Las opciones disponibles son específicas del proveedor de servicios en la nube. Para obtener más información, consulte las opciones de configuración de clústeres de AWS, GCP y Azure.
Si desea crear o actualizar un clúster, debe especificar esta configuración.
spec.deploymentSpec.providerSettings.providerNameTipo: string
Condicional
Proveedor de servicios en la nube en el que Atlas aprovisiona los hosts.
AWS
Amazon AWS
GCP
Google Cloud Platform
AZUR
Microsoft Azure
spec.deploymentSpec.providerSettings.instanceSizeNameTipo: string
Requerido
Atlas ofrece diferentes niveles de clúster, cada uno con una capacidad de almacenamiento y un tamaño de RAM predeterminados. El clúster que seleccione se usará para todos los servidores que contienen datos en su clúster. Para obtener más información, consulte los tamaños de almacenamiento personalizados de AWS, GCP y Azure.
Si cambia el nombre del tamaño de la instancia después de implementar el clúster, Atlas cambiará la implementación de la base de datos al tamaño de instancia que especifique, a menos que esté fuera del rango especificado
spec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSizeen yspec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizecon el escalado automático habilitado. Para obtener más información, consultespec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.minInstanceSizespec.advancedDeploymentSpec.replicationSpecs.regionConfigs.autoScaling.compute.maxInstanceSizey.Nota
Puede cambiar esta configuración para actualizar un clúster
M0,M2oM5a un clústerM10+. Sin embargo, no puede actualizar un clústerM0,M2oM5a otro clúster gratuito o compartido. Por ejemplo, no puede actualizar un clústerM0a un clústerM5.
spec.deploymentSpec.providerSettings.regionNameTipo: string
Condicional
Ubicación física de su clúster de MongoDB. La región que elija puede afectar la latencia de red de los clientes que acceden a sus bases de datos.
Para obtener una lista completa de los valores de los nombres de las regiones, consulte las páginas de referencia del proveedor de la nube:
Para clústeres multirregionales, consulte. Debe
spec.deploymentSpec.replicationSpecsconfigurarspec.deploymentSpec.providerSettings.regionNamespec.deploymentSpec.replicationSpecso.
spec.deploymentSpec.replicationSpecsTipo: matriz de objetos
Condicional
Lista que contiene las configuraciones para las regiones de tu clúster. Use este parámetro para clústeres multiregionales. Debe configurar
spec.deploymentSpec.providerSettings.regionNameospec.deploymentSpec.replicationSpecs.¿Cuándo se debe utilizar este parámetro?
CondiciónNecesidadValuesEstás implementando clústeres globales.
Requerido
Cada objeto de la matriz representa una zona donde Atlas implementa los nodos de su clúster.
Está implementando conjuntos de réplicas no globales y clústeres fragmentados.
Opcional
Este arreglo contiene un objeto que representa donde Atlas implementa los nodos de tu clúster.
Si especifica este parámetro, también debe especificar
spec.deploymentSpec.clusterTypespec.deploymentSpec.replicationSpecs.numShardsy.
spec.deploymentSpec.replicationSpecs.numShardsTipo: entero
Condicional
Entero positivo que especifica la cantidad de fragmentos a implementar para un clúster fragmentado.
Si utiliza el parámetro, debe configurar este
spec.deploymentSpec.replicationSpecsparámetro.Atlas acepta valores de
1a50, ambos inclusive. El valor predeterminado es1.Si especifica un valor de
1yspec.deploymentSpec.clusterTypeestableceSHARDEDen, Atlas implementa un clúster fragmentado de un solo fragmento.Si especifica
1yspec.deploymentSpec.clusterTypeestableceREPLICASETen, Atlas implementa un conjunto de réplicas.No se debe crear un clúster particionado con una única partición para entornos de producción. Los clústeres particionados de una sola partición no ofrecen los mismos beneficios que las configuraciones multipartición.
spec.deploymentSpec.replicationSpecs.zoneNameTipo: string
Opcional
Etiqueta legible que identifica la zona en un clúster global. Proporcione este valor solo si
spec.deploymentSpec.clusterTypeestableceGEOSHARDEDen.
spec.deploymentSpec.tagsTipo: arreglo
Opcional
Lista que contiene etiquetas (pares clave-valor) para comprender, organizar e identificar mejor las implementaciones de bases de datos. Para obtener más información, consulte Etiquetas en clústeres.
spec.deploymentSpec.versionReleaseSystemTipo: string
Condicional
Cadencia de lanzamiento que Atlas utiliza para este clúster. Atlas acepta:
CONTINUOUSAtlas crea su clúster con la versión más reciente de MongoDB. Atlas actualiza automáticamente su clúster con las últimas versiones principales y rápidas de MongoDB a medida que están disponibles.LTSAtlas crea su clúster con la última versión de parche de MongoDB que especifique en elspec.deploymentSpec.mongoDBMajorVersionparámetro. Atlas actualiza automáticamente su clúster con las siguientes versiones de parche de esta versión de MongoDB. Atlas no actualiza su clúster con las nuevas versiones rápidas o principales de MongoDB a medida que estén disponibles.Si se omite, es por defecto
LTS.Si establece este parámetro en,
CONTINUOUSdebe omitir elspec.deploymentSpec.mongoDBMajorVersionparámetro.
spec.processArgsTipo: objeto
Opcional
Objeto que contiene las opciones de configuración avanzadas para su clúster.
spec.processArgs.defaultReadConcernTipo: string
Opcional
Cadena que indica el nivel predeterminado de reconocimiento solicitado a MongoDB para las operaciones de lectura establecidas para este clúster.
Los clústeres MongoDB están disponibles 4.4 de forma predeterminada.
Los 5.0 clústeres MongoDB tienen como valor predeterminado ser locales.
spec.processArgs.defaultWriteConcernTipo: string
Opcional
Cadena que indica el nivel predeterminado de reconocimiento solicitado a MongoDB para las operaciones de escritura establecidas para este clúster.
Los clústeres MongoDB 4.4 tienen como valor 1 predeterminado.
Las versiones y posteriores de MongoDB tienen como valor predeterminado 5.0 la mayoría de los clústeres.
spec.processArgs.failIndexKeyTooLongTipo: booleano
Opcional
Marca que indica si se debe fallar la operación y devolver un error al insertar o actualizar documentos cuyas entradas indexadas superen 1024 bytes. Si se establece
falseen, escribe los documentosmongodque superen este límite, pero no los indexa.Esta opción corresponde al
param.failIndexKeyTooLongmongodparámetro.
spec.processArgs.javascriptEnabledTipo: booleano
Opcional
Bandera que indica si el clúster permite la ejecución de operaciones que realizan ejecuciones de JavaScript del lado del servidor.
Si el clúster ejecuta una versión de MongoDB inferior a 4.4, esta opción corresponde a modificar la opción del archivo de configuración de
security.javascriptEnabledpara cadamongoden el clúster.Si el clúster ejecuta la versión 4.4 o superior de MongoDB, esta opción corresponde a modificar la opción del archivo de configuración
security.javascriptEnabledpara cadamongodymongosen el clúster.
spec.processArgs.minimumEnabledTlsProtocolTipo: entero
Opcional
Cadena que indica la versión mínima de TLS que el clúster acepta para las conexiones entrantes. Los clústeres que usan TLS 1.0 o 1.1 deberían considerar configurar 1TLS.2 como la versión mínima del protocolo TLS.
Para aprender más, consulte ¿Qué versiones de TLS admite Atlas?.
Esta opción corresponde a la
net.ssl.disabledProtocolsmongodopción del archivo de configuración.
spec.processArgs.noTableScanTipo: booleano
Opcional
Bandera que indica si el clúster deshabilita la ejecución de cualquier consulta que requiera un escaneo de colección para devolver resultados.
Esta opción corresponde al
notablescanmongodparámetro.
spec.processArgs.oplogSizeMBTipo: entero
Opcional
Número que indica el límite de almacenamiento del registro de operaciones de un clúster, expresado en megabytes. Un valor de
nullindica que el clúster utiliza el tamaño predeterminado del registro de operaciones calculado por Atlas.Esta opción corresponde a la
replication.oplogSizeMBmongodopción del archivo de configuración.
spec.processArgs.sampleRefreshIntervalBIConnectorTipo: entero
Opcional
Número que indica los documentos por base de datos a muestrear al momento de recopilar información del esquema.
Este parámetro corresponde a la opción sampleSize mongosqld.
spec.processArgs.sampleSizeBIConnectorTipo: entero
Opcional
Número que indica el intervalo en segundos en el que el proceso mongosqld vuelve a muestrear los datos para crear su esquema relacional.
Este parámetro corresponde a la opción mongosqld sampleRefreshIntervalSecs.
spec.projectRef.nameTipo: string
Requerido
Nombre del proyecto al que pertenece el clúster. Debe especificar un recurso personalizado
AtlasProjectexistente.
spec.serverlessSpecTipo: arreglo
Condicional
Lista que contiene los parámetros de instancia sin servidor de la API. Para obtener una lista completa de los parámetros disponibles, consulte la API de instancias sin servidor de Atlas.
Importante
Debe especificar
spec.deploymentSpec,spec.advancedDeploymentSpecospec.serverlessSpecen su configuración.
spec.serverlessSpec.privateEndpointsTipo: arreglo
Opcional
Lista que contiene las configuraciones de puntos finales privados para la instancia sin servidor.
spec.serverlessSpec.providerSettingsTipo: Objeto
Condicional
Configuración que especifica la configuración de los hosts aprovisionados donde se ejecuta MongoDB. Las opciones disponibles son específicas del proveedor de servicios en la nube. Para obtener más información, consulte las opciones de configuración de instancias sin servidor de AWS, GCP y Azure.
Si desea crear o actualizar una instancia sin servidor, debe especificar esta configuración.
spec.serverlessSpec.providerSettings.providerNameTipo: string
Condicional
Proveedor de servicios en la nube en el que Atlas aprovisiona el host para una instancia sin servidor.
Atlas acepta los siguientes valores:
AWS
Amazon AWS
GCP
Google Cloud Platform
AZUR
Microsoft Azure
spec.serverlessSpec.providerSettings.regionNameTipo: string
Condicional
Ubicación física de su instancia sin servidor de MongoDB. La región que elija puede afectar la latencia de red para los clientes que acceden a sus bases de datos.
Para obtener una lista completa de los valores de los nombres de las regiones, consulte las páginas de referencia del proveedor de la nube:
spec.serverlessSpec.tagsTipo: arreglo
Opcional
Lista que contiene etiquetas (pares clave-valor) para comprender, organizar e identificar mejor las implementaciones de bases de datos. Para obtener más información, consulte Etiquetas en clústeres.
status.connectionStringsTipo: arreglo
Requerido
Lista que contiene las URL de conexión para acceder al clúster. Este parámetro aparece después de crear o actualizar un clúster.
Nota
No se puede usar una URL de conexión directamente. Los clústeres de Atlas requieren autenticación. Debe crear al menos un recurso
AtlasDatabaseUserpersonalizado para que la aplicación de su clúster de Kubernetes pueda conectarse al clúster de Atlas. El operador de Kubernetes de Atlas crea un secreto especial.Para cada combinación de clúster y usuario de base de datos del proyecto. La aplicación de su clúster de Kubernetes puede usar este secreto para conectarse al clúster de Atlas. Elspec.scopesparámetro delAtlasDatabaseUserrecurso personalizado restringe los clústeres que crean el usuario de base de datos.
Para conocer los parámetros de configuración disponibles para un clúster y un clúster avanzado desde la API, consulte la API de clústeres Atlas y la API de clústeres avanzados.
Nota
Los siguientes parámetros están obsoletos en la API de Atlas y el Atlas Kubernetes Operator no los admite:
replicationSpecreplicationFactor