Cree un clúster de Atlas a partir de una plantilla usando Terraform

Esta página describe cómo usar la plantilla Atlas para archivos Terraform incluida en la extensión MongoDB para Visual Studio Code para crear clústeres Flex.

Después de cargar la plantilla, configuramos el clúster y proporcionamos detalles sobre su cuenta de Atlas. Luego se utilizan los comandos de Terraform para planificar, aplicar y destruir el clúster de Atlas.

Requisitos previos

Antes de utilizar la plantilla Atlas para archivos Terraform incluidos con la Extensión de MongoDB para Visual Studio Code, debes:

Instala la extensión MongoDB for VS Code
Instalar Terraform
Tener una cuenta de Atlas.
Tener una organización de Atlas.
Tener una cuenta de servicio en una organización de |servicio| con el rol Organization Owner o Organization Project Creator.

Procedimientos

Crear un archivo Terraform Atlas utilizando la plantilla

Utiliza la plantilla de Atlas para archivos de Terraform incluida con la Extensión de VS Code para configurar un clúster de Atlas:

En Visual Studio Code, crea un archivo nuevo.

Sistema operativo	Método	Acciones
Any	Menú de Visual Studio Code	File > New File
macOS	Atajo de teclado	Pulse `Command` + `N`
Windows y Linux	Atajo de teclado	Pulse `Control` + `N`

Guarde el archivo. `main.tf`Nómbralo.

Nota

main.tf es el nombre de archivo recomendado para el punto de entrada a un módulo de Terraform.

En el archivo `main.tf`, teclea `atlas`, luego presiona la tecla Enter o Return.

La extensión de MongoDB para VSCode rellena el archivo con una configuración de ejemplo que utiliza el proveedor Terraform de MongoDB Atlas para crear un clúster Flex.

Actualiza la configuración de Atlas Terraform para configurar tu clúster.

El cursor se mueve para seleccionar el valor del argumento name del recurso mongodbatlas_project.

Proporcionar valores para los siguientes argumentos para configurar el clúster:

Tip

Presiona la tecla Tab para seleccionar el siguiente argumento del template que debes actualizar.

Atributo	Valor
`mongodbatlas_project` `.name`	Nombre del proyecto Atlas que crea esta configuración.
`mongodbatlas_advanced_cluster` `.name`	Nombre del clúster de Atlas Flex que crea esta configuración.
`mongodbatlas_advanced_cluster` `.replication_specs.` `region_configs.` `backing_provider_name`	Proveedor en el que se aloja el clúster Atlas Flex que crea esta configuración. Elija uno de los siguientes valores aceptados: `AWS` `AZURE` `GCP`
`mongodbatlas_advanced_cluster` `.replication_specs.` `region_configs.` `region_name`	Región en la que se implementará el clúster Atlas Flex que crea esta configuración. Asegúrese de que la región seleccionada sea compatible con clústeres Flex. Para obtener detalles sobre las regiones que admite cada proveedor, consulte las siguientes secciones en la documentación de Atlas: Amazon Web Services Google Cloud Platform Microsoft Azure

Actualice las `local` variables.

Advertencia

Las variables local contienen información confidencial. No registre estos valores en un repositorio de acceso público.

Proporcione valores para las siguientes local variables:

Variable	Valor
`mongodb_atlas_client_id`	ID de cliente de la cuenta de servicio de Atlas.
`mongodb_atlas_client_secret`	Secreto del cliente de la cuenta de servicio de Atlas.
`mongodb_atlas_org_id`	Identificador de la Organización de Atlas en la que deseas crear un proyecto.
`mongodb_atlas_database_username`	Nombre de usuario del usuario de base de datos MongoDB que Atlas crea para tu clúster.
`mongodb_atlas_database_user_password`	Contraseña para el usuario de base de datos MongoDB especificado en `mongodb_atlas_database_username`.
`mongodb_atlas_accesslistip`	Dirección IP o bloque CIDR desde el cual se puede acceder a tu clúster de Atlas.

Nota

La plantilla se autentica en Atlas mediante una cuenta de servicio. También se admiten claves API, pero las cuentas de servicio son el método de autenticación recomendado. Para obtener más información sobre ambos métodos, consulte la guía de autenticación del proveedor de Terraform para MongoDB Atlas.

Ejemplo

Utilice un archivo de variables de entrada para maximizar la seguridad

Para maximizar la seguridad, considere tomar los siguientes pasos:

Defina las local variables en un archivo variables de entrada.
variable "mongodb_atlas_client_id" { default = "my-client-id" } variable "mongodb_atlas_client_secret" { default = "my-client-secret" }
Excluye el archivo de variables de entrada de tu repositorio. Por ejemplo, añade el nombre del archivo al archivo .gitignore de tu repositorio.
Hace referencia a las variables del archivo de variables de entrada en el archivo main.tf anteponiéndoles var..
provider "mongodbatlas" { client_id = var.mongodb_atlas_client_id client_secret = var.mongodb_atlas_client_secret }

Agrega opciones de configuración opcionales al archivo `main.tf`.

Para obtener una lista completa de las opciones de configuración compatibles, consulte la documentación del proveedor de Terraform de MongoDB Atlas.

Para implementaciones en producción, considere el módulo oficial MongoDB Atlas Cluster, que incluye el recurso de clúster con la configuración predeterminada de mejores prácticas para entornos de producción.

Nota

Los clústeres Flex no son compatibles con todas las configuraciones disponibles en el proveedor Terraform de MongoDB Atlas. Para consultar la lista de configuraciones no compatibles, consulte la documentación de Atlas.

Guarda el archivo `main.tf`.

Crea el clúster de Atlas utilizando Terraform

Después de crear un archivo Terraform utilizando la plantilla, crea el clúster de Atlas:

Navega hasta el directorio donde se guardó el archivo `main.tf` .

Ejecuta el comando `terraform init` para instalar los proveedores necesarios.

La siguiente salida indica que el Proveedor Terraform de MongoDB Atlas está instalado y listo para usar:

terraform init

Initializing the backend...
Initializing provider plugins...
- Finding mongodb/mongodbatlas versions matching "~> 2.0"...
- Installing mongodb/mongodbatlas v2.18.0...
- Installed mongodb/mongodbatlas v2.18.0 (signed by a HashiCorp partner, key ID 2A32ED1F3AD25ABF)
Partner and community providers are signed by their developers.
If you'd like to know more about provider signing, you can read about it here:
https://developer.hashicorp.com/terraform/cli/plugins/signing
Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so Terraform can guarantee to make the same selections by default when you run
"terraform init" in the future.
Terraform has been successfully initialized!
You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.
If you ever set or change modules or backend configuration, rerun this command
to reinitialize your working directory. If you forget, other commands will
detect it and remind you to do so if necessary.

Ejecuta el comando `terraform plan` para ver qué ocurre cuando aplicas la configuración.

La siguiente salida muestra lo que ocurre cuando se aplica la configuración de Terraform:

terraform plan

Terraform used the selected providers to generate the following execution
plan. Resource actions are indicated with the following symbols:
  + create
Terraform will perform the following actions:
  # mongodbatlas_advanced_cluster.my_cluster will be created
  + resource "mongodbatlas_advanced_cluster" "my_cluster" {
      + advanced_configuration                                 = (known after apply)
      + backup_enabled                                         = (known after apply)
      + bi_connector_config                                    = (known after apply)
      + cluster_id                                             = (known after apply)
      + cluster_type                                           = "REPLICASET"
      + config_server_management_mode                          = (known after apply)
      + config_server_type                                     = (known after apply)
      + connection_strings                                     = (known after apply)
      + create_date                                            = (known after apply)
      + delete_on_create_timeout                               = true
      + encryption_at_rest_provider                           = (known after apply)
      + global_cluster_self_managed_sharding                   = (known after apply)
      + mongo_db_major_version                                 = (known after apply)
      + mongo_db_version                                       = (known after apply)
      + name                                                   = "atlasClusterName"
      + paused                                                 = (known after apply)
      + pit_enabled                                           = (known after apply)
      + project_id                                             = (known after apply)
      + redact_client_log_data                                 = (known after apply)
      + replica_set_scaling_strategy                           = (known after apply)
      + replication_specs                                      = [
          + {
              + container_id   = (known after apply)
              + external_id    = (known after apply)
              + region_configs = [
                  + {
                      + analytics_auto_scaling = (known after apply)
                      + analytics_specs        = (known after apply)
                      + auto_scaling           = (known after apply)
                      + backing_provider_name  = "AWS"
                      + electable_specs        = (known after apply)
                      + priority               = 7
                      + provider_name          = "FLEX"
                      + read_only_specs        = (known after apply)
                      + region_name            = "US_EAST_1"
                    },
                ]
              + zone_id        = (known after apply)
              + zone_name      = (known after apply)
            },
        ]
      + root_cert_type                                         = (known after apply)
      + state_name                                             = (known after apply)
      + termination_protection_enabled                         = (known after apply)
      + use_aws_time_based_snapshot_copy_for_fast_initial_sync = (known after apply)
      + version_release_system                                 = (known after apply)
    }
  # mongodbatlas_database_user.my_user will be created
  + resource "mongodbatlas_database_user" "my_user" {
      + auth_database_name = "admin"
      + aws_iam_type       = "NONE"
      + id                 = (known after apply)
      + ldap_auth_type     = "NONE"
      + oidc_auth_type     = "NONE"
      + password           = (sensitive value)
      + password_wo        = (write-only attribute)
      + project_id         = (known after apply)
      + username           = "myUser"
      + x509_type          = "NONE"
      + roles {
          + database_name = "admin"
          + role_name     = "atlasAdmin"
        }
    }
  # mongodbatlas_project.my_project will be created
  + resource "mongodbatlas_project" "my_project" {
      + cluster_count                                           = (known after apply)
      + created                                                 = (known after apply)
      + id                                                      = (known after apply)
      + ip_addresses                                            = (known after apply)
      + is_cluster_ai_assistant_enabled                         = (known after apply)
      + is_collect_database_specifics_statistics_enabled        = (known after apply)
      + is_data_explorer_enabled                                = (known after apply)
      + is_data_explorer_gen_ai_features_enabled                = (known after apply)
      + is_data_explorer_gen_ai_sample_document_passing_enabled = (known after apply)
      + is_extended_storage_sizes_enabled                       = (known after apply)
      + is_native_reranking_enabled                             = (known after apply)
      + is_performance_advisor_enabled                          = (known after apply)
      + is_realtime_performance_panel_enabled                   = (known after apply)
      + is_schema_advisor_enabled                               = (known after apply)
      + is_slow_operation_thresholding_enabled                  = (known after apply)
      + name                                                    = "atlasProjectName"
      + org_id                                                  = "5d3716bfcf09a21576d7983e"
      + region_usage_restrictions                               = (known after apply)
      + with_default_alerts_settings                            = true
    }
  # mongodbatlas_project_ip_access_list.my_ipaddress will be created
  + resource "mongodbatlas_project_ip_access_list" "my_ipaddress" {
      + aws_security_group = (known after apply)
      + cidr_block         = (known after apply)
      + comment            = "My IP Address"
      + id                 = (known after apply)
      + ip_address         = "203.0.113.10"
      + project_id         = (known after apply)
    }
Plan: 4 to add, 0 to change, 0 to destroy.
Changes to Outputs:
  + connection_strings = (known after apply)
─────────────────────────────────────────────────────────────────────────────
Note: You didn't use the -out option to save this plan, so Terraform can't
guarantee to take exactly these actions if you run "terraform apply" now.

Procede al siguiente paso si la información es correcta.

Ejecute el comando `terraform apply` para crear un clúster de Atlas desde la configuración de Terraform.

Escribe yes cuando se te pida para confirmar que deseas aplicar la configuración.

Nota

El comando terraform apply puede tardar varios minutos en completarse.

La siguiente salida indica que su clúster de Atlas se ha creado. Puede crear una conexión a esta implementación utilizando la extensión de VS Code con la cadena de conexión que se muestra:

terraform apply

Apply complete! Resources: 4 added, 0 changed, 0 destroyed.
Outputs:
connection_strings = "mongodb+srv://atlasClusterName.xxxxx.mongodb.net"

Borra el clúster de Atlas utilizando Terraform

Advertencia

Al eliminar un clúster, se destruyen las bases de datos, colecciones y documentos almacenados en él y todos los demás recursos definidos en la configuración de Terraform en la que configuraste el clúster.

Proceder con precaución.

Para borrar el clúster de Atlas:

Navega hasta el directorio donde se guardó el archivo `main.tf` .

Ejecute el comando `terraform destroy` para eliminar los recursos definidos en la configuración.

terraform destroy

Escribe yes cuando se te solicite confirmar que deseas destruir los recursos definidos en la configuración.

Nota

El comando terraform destroy puede tardar varios minutos en completarse.

La siguiente salida indica que el clúster de Atlas y todos los recursos asociados se eliminan:

Destroy complete! Resources: 4 destroyed.

Volver

AI & Data Usage

Comandos

Cree un clúster de Atlas a partir de una plantilla usando Terraform

Requisitos previos

Procedimientos

Crear un archivo Terraform Atlas utilizando la plantilla

En Visual Studio Code, crea un archivo nuevo.

Guarde el archivo. main.tfNómbralo.

En el archivo main.tf, teclea atlas, luego presiona la tecla Enter o Return.

Actualiza la configuración de Atlas Terraform para configurar tu clúster.

Actualice las local variables.

Agrega opciones de configuración opcionales al archivo main.tf.

Guarda el archivo main.tf.

Crea el clúster de Atlas utilizando Terraform

Navega hasta el directorio donde se guardó el archivo main.tf .

Ejecuta el comando terraform init para instalar los proveedores necesarios.

Ejecuta el comando terraform plan para ver qué ocurre cuando aplicas la configuración.

Ejecute el comando terraform apply para crear un clúster de Atlas desde la configuración de Terraform.

Borra el clúster de Atlas utilizando Terraform

Navega hasta el directorio donde se guardó el archivo main.tf .

Ejecute el comando terraform destroy para eliminar los recursos definidos en la configuración.

Guarde el archivo. `main.tf`Nómbralo.

En el archivo `main.tf`, teclea `atlas`, luego presiona la tecla Enter o Return.

Actualice las `local` variables.

Agrega opciones de configuración opcionales al archivo `main.tf`.

Guarda el archivo `main.tf`.

Navega hasta el directorio donde se guardó el archivo `main.tf` .

Ejecuta el comando `terraform init` para instalar los proveedores necesarios.

Ejecuta el comando `terraform plan` para ver qué ocurre cuando aplicas la configuración.

Ejecute el comando `terraform apply` para crear un clúster de Atlas desde la configuración de Terraform.

Navega hasta el directorio donde se guardó el archivo `main.tf` .

Ejecute el comando `terraform destroy` para eliminar los recursos definidos en la configuración.