Puede usar Terraform para gestionar su infraestructura de MongoDB Atlas como Infrastructure as Code con el proveedor de Atlas Terraform. El proveedor Atlas Terraform automatiza las implementaciones de infraestructura al simplificar el proceso de provisionamiento, gestionar y controlar la infraestructura de Atlas como Infrastructure as Code.
Esta guía le enseña cómo crear y destruir clústeres de Atlas en una organización de MongoDB Atlas existente.
Nota
El proveedor de Atlas Terraform admite cualquier versión de MongoDB que Atlas admita en su Proyecto y región. Para aprender a cambiar la versión de MongoDB de su clúster, consulte Actualizar una versión principal.
Una vez que hayas configurado un entorno de prueba, continúa experimentando con una infraestructura gestionada por Terraform con recursos adicionales de MongoDB y HashiCorp.
Los clústeres de Atlas Infinite son compatibles con el proveedor de Atlas para Terraform. Para aprender más, consulta Crear un clúster de Atlas Infinite con Terraform y MongoDB Atlas Infinite: Descripción general.
Requisitos previos
Antes de implementar MongoDB Atlas con Terraform, debe:
Crear una cuentaen Atlas.
Obtén tu Identificador de la Organización de la que eres el
Organization Owner.Tip
Se puede encontrar el Identificador de la organización en la interfaz de usuario de Atlas, en General Settings de la organización.
Configura la autenticación de la cuenta de servicio (SA). El rol de Organization Owner es necesario para ver el Identificador de la Organización, gestionar las cuentas de servicio y crear o borrar clúster y otros recursos del Proyecto.
Instala Terraform.
Implementa MongoDB Atlas con Terraform
Rellenar archivos de soporte.
Añada el siguiente contenido a provider.tf:
provider "mongodbatlas" { client_id = var.client_id client_secret = var.client_secret}Añada el siguiente contenido a variables.tf:
variable "client_id" { description = "Atlas Service Account client ID" type = string}
variable "client_secret" { description = "Atlas Service Account client secret" type = string sensitive = true}
variable "org_id" { description = "Atlas organization ID" type = string}Añada el siguiente contenido a versions.tf:
terraform { required_providers { mongodbatlas = { source = "mongodb/mongodbatlas" version = "~> 2.2" } } required_version = "~> 1.0"}Nota
El ID de cliente de su cuenta de servicio de Atlas y el secreto de cliente son secretos. Considere almacenarlos como variables de entorno.
Configura los contenidos de main.tf.
Nota
El siguiente ejemplo utiliza el módulo de Proyecto para crear el Proyecto y el mongodbatlas_advanced_cluster recurso para crear un clúster gratuito.
Añada el siguiente contenido a su archivo main.tf:
module "project" { source = "terraform-mongodbatlas-modules/project/mongodbatlas" name = "tenant-example-project" org_id = var.org_id}
resource "mongodbatlas_advanced_cluster" "this" { project_id = module.project.id name = "TenantCluster" cluster_type = "REPLICASET"
replication_specs = [ { region_configs = [ { provider_name = "TENANT" backing_provider_name = "AWS" region_name = "US_EAST_1" priority = 7 electable_specs = { instance_size = "M0" } } ] } ]}Si trabaja con un proveedor de nube o una región diferente, puede actualizar los siguientes campos para que coincidan con su entorno.
Campo | Nuevo valor |
|---|---|
| Tu proveedor. Los posibles valores son: |
| Consulta Proveedores de nube y regiones para conocer todas las regiones que puedes utilizar. |
Importante
Puede establecer database_edition en el recurso mongodbatlas_advanced_cluster cuando crea un clúster dedicado. No puedes cambiarlo después, y no puedes escalar un clúster dedicado a un clúster gratuito o un clúster flexible. database_edition no está disponible para clústeres gratuitos, como el clúster M0 de este ejemplo, y para clústeres Flex.
El recurso mongodbatlas_advanced_cluster, y tanto la fuente de datos singular (mongodbatlas_advanced_cluster) como las fuentes de datos plurales (mongodbatlas_advanced_clusters), exponen database_edition y el atributo de solo lectura effective_database_edition. Dado que database_edition es opcional, utilice effective_database_edition para confirmar qué edición asignó Atlas, incluso si no la configuró usted mismo.
Para crear un clúster de Atlas Infinite dedicado, consulte Crear un clúster de Atlas Infinite con Terraform.
(Opcional) Parámetros de visualización.
Puedes mostrar información desde tu configuración de Terraform en la ventana de tu terminal. Esto resulta útil para valores que no conocerás hasta que Atlas cree los recursos, como tu cadena de conexión.
Si deseas mostrar tus parámetros después de implementar tu proyecto, agrega algunas líneas de código de salida a tu archivo main.tf.
Implementa tu infraestructura.
Para implementar su infraestructura, ejecute el siguiente comando:
terraform applyCuando se le pida Do you want to perform these actions?, introduzca yes.
Nota
Los nuevos recursos de Atlas pueden tardar algunos minutos en aprovisionarse. El proveedor de Terraform de Atlas te actualiza cada diez segundos hasta que se complete.
Cree un clúster de Atlas Infinite con Terraform
El siguiente ejemplo utiliza Terraform para crear un clúster de Atlas Infinite con el escalado automático de computación habilitado:
resource "mongodbatlas_advanced_cluster" "infinite" { project_id = module.project.id name = "InfiniteCluster" cluster_type = "REPLICASET" database_edition = "INFINITE"
replication_specs = [ { region_configs = [ { provider_name = "AWS" priority = 7 region_name = "US_EAST_1" electable_specs = { instance_size = "M10" node_count = 2 } auto_scaling = { compute_enabled = true compute_max_instance_size = "M60_GEN_2" storage_config = { shard_size_limit_gb = 10240 } } } ] } ]}Cuando crea un clúster de Atlas Infinite con Terraform, se aplican los siguientes requisitos y limitaciones:
Configuración obligatoria: Establezca
database_editionen"INFINITE"en el recursomongodbatlas_advanced_clustery establezca un valorcompute_enabledexplícito (trueofalse) enauto_scaling. Atlas requiere este valor al crear el clúster.Edición de base de datos inmutable: No puede cambiar la edición de base de datos de un clúster después de crearlo.
Limitaciones de la vista previa pública: Todas las demás limitaciones de la vista previa pública de Atlas Infinite se aplican a los clústeres que implementa con Terraform. Para aprender más, consulte No compatible en la vista previa pública.
Tipo de clúster: Los clústeres de Atlas Infinite dedicados solo admiten el tipo de clúster
REPLICASET.Nivel máximo de escalado automático:
compute_max_instance_sizees obligatorio cuandocompute_enabledestrue. Los clústeres de Atlas Infinite en el nivelM30y superiores se ejecutan en hardware Amazon Web Services Gen2, por lo que debe añadir_GEN_2al nombre del nivel, como enM60_GEN_2. Para aprender más, se puede consultar clústeres dedicados de Gen2.Nodos elegibles: Un clúster de Atlas Infinite tiene dos nodos de computación elegibles, uno primario y otro en espera, así que establezca
node_counten2. Para aprender más, consulte Replicación y conmutación por error.Nodos de solo lectura y nodos de análisis: para servir más lecturas o para aislar las query de análisis de su carga de trabajo operativa, configure
read_only_specsoanalytics_specsjunto conelectable_specsen el mismo objetoregion_configs. Para aprender más, consulte Aislamiento de carga de trabajo en clústeres de Atlas Infinite.Límite de almacenamiento:
storage_config.shard_size_limit_gbsolo es necesario si incluyestorage_config. Si omitestorage_config, Atlas aplica el límite de almacenamiento máximo por defecto. Para aprender más, consulte Límite de almacenamiento máximo.
Nota
storage_config.shard_size_limit_gb establece la cantidad máxima de datos que el clúster puede almacenar. Para aprender más, consulta la documentación del proveedor de Terraform.
Verificar la implementación
Una vez que terraform apply se complete, confirme que el clúster está implementado.
Aparece un nuevo clúster en la interfaz de usuario de Atlas en su proyecto.
Si agregó valores de salida a
main.tf, la cadena de conexión aparece en la salida de Terraform.
Terminar la instancia de MongoDB Atlas
Para borrar todos los recursos creados en tu directorio de Terraform, ejecuta el siguiente comando:
terraform destroyAdvertencia
Si elimina todos sus recursos, no podrá recuperarlos.
Cuando se le pida Do you really want to destroy all resources?, introduzca yes.
Próximos pasos
Después de implementar el clúster, puede:
Escalar a un clúster dedicado: Revisión el módulo de clúster y la documentación del proveedor de Atlas Terraform para configuraciones más completas.
Conectarse al clúster: utilice la cadena de conexión del objeto del clúster o de los valores de salida de Terraform.
Recursos adicionales: