Get Started with Terraform and the MongoDB Atlas Provider

Create and navigate to an empty directory.

mkdir terraform-proj
cd terraform-proj

Create your terraform files.

Create the main.tf, provider.tf, variables.tf, and versions.tf files.

touch main.tf provider.tf variables.tf versions.tf

Populate supporting files.

Add the following content to provider.tf:

provider "mongodbatlas" {
  client_id     = var.client_id
  client_secret = var.client_secret
}

Add the following content to 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
}

Add the following content to versions.tf:

terraform {
  required_providers {
    mongodbatlas = {
      source  = "mongodb/mongodbatlas"
      version = "~> 2.2"
    }
  }
  required_version = "~> 1.0"
}

Configure main.tf contents.

Add the following content to your main.tf file:

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"
          }
        }
      ]
    }
  ]
}

If you work with a different cloud provider or region, you can update the following fields to match your environment.

The mongodbatlas_advanced_cluster resource, and both the singular (mongodbatlas_advanced_cluster) and plural (mongodbatlas_advanced_clusters) data sources, expose database_edition and the read-only effective_database_edition attribute. Because database_edition is optional, use effective_database_edition to confirm which edition Atlas assigned, even if you didn't set it yourself.

To create a dedicated cluster on Atlas Infinite, set database_edition to "INFINITE" and set compute_enabled in auto_scaling, as the following example shows:

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
            }
          }
        }
      ]
    }
  ]
}

Dedicated Atlas Infinite clusters support the REPLICASET cluster type only.

compute_max_instance_size is required when compute_enabled is true. M30+ Atlas Infinite clusters are available on AWS Gen2 only, so append _GEN_2 to the tier name, as in M60_GEN_2. To learn more, see Gen2 Dedicated Clusters.

An Atlas Infinite cluster has two electable compute nodes, a primary and a standby, so set node_count to 2. To learn more, see Replication and Failover.

To serve more reads or to isolate analytics queries from your operational workload, add read-only or analytics nodes by setting read_only_specs or analytics_specs alongside electable_specs in the same region_configs object. To learn more, see Workload Isolation on Atlas Infinite clusters.

storage_config.shard_size_limit_gb is required only if you include storage_config. If you omit storage_config, Atlas applies the default maximum storage limit. To learn more, see Max Storage Limit.

(Optional) Display parameters.

You can output information from your Terraform configuration to your terminal window. This is useful for values you won't know until Atlas creates the resources, such as your connection string.

If you want to display your parameters after you deploy your project, add some output lines of code to your main.tf file.

Initialize your project.

To initialize your project, run the following command:

terraform init

This command also downloads and installs the MongoDB Atlas Provider, if you haven't already.

View your execution plan.

To view your execution plan, run the following command:

terraform plan

Terraform details the changes that it plans to make. If the output is not what you expect, then there might be an issue in your main.tf file.

Deploy your infrastructure.

To deploy your infrastructure, run the following command:

terraform apply

When prompted Do you want to perform these actions?, enter yes.