-
Notifications
You must be signed in to change notification settings - Fork 31
DOCSP-48744 -- multi-region tf example #230
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
jvincent-mongodb
merged 2 commits into
mongodb:feature-multi-region
from
jvincent-mongodb:DOCSP-48744
May 27, 2025
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
372 changes: 372 additions & 0 deletions
372
source/includes/examples/tf-example-complete-staging-prod-multi-region.tf
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,372 @@ | ||||||
# Add the Mongodb Atlas Provider | ||||||
terraform { | ||||||
required_providers { | ||||||
mongodbatlas = { | ||||||
source = "mongodb/mongodbatlas", | ||||||
version = "1.34.0" | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
# Configure the MongoDB Atlas Provider | ||||||
provider "mongodbatlas" { | ||||||
public_key = var.mongodbatlas_public_key | ||||||
private_key = var.mongodbatlas_private_key | ||||||
} | ||||||
|
||||||
# Create a Project | ||||||
resource "mongodbatlas_project" "atlas-project" { | ||||||
org_id = var.atlas_org_id | ||||||
name = var.atlas_project_name | ||||||
} | ||||||
|
||||||
# Create an Atlas Advanced Cluster | ||||||
resource "mongodbatlas_advanced_cluster" "atlas-cluster" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
name = "ClusterPortalProd" | ||||||
cluster_type = "REPLICASET" | ||||||
mongo_db_major_version = 8.0 | ||||||
replication_specs { | ||||||
region_configs { | ||||||
electable_specs { | ||||||
instance_size = "M10" | ||||||
node_count = 2 | ||||||
} | ||||||
provider_name = "GCP" | ||||||
priority = 7 | ||||||
region_name = "NORTH_AMERICA_NORTHEAST_1" | ||||||
} | ||||||
region_configs { | ||||||
electable_specs { | ||||||
instance_size = "M10" | ||||||
node_count = 3 | ||||||
} | ||||||
provider_name = "GCP" | ||||||
priority = 6 | ||||||
region_name = "WESTERN_US" | ||||||
} | ||||||
} | ||||||
tags { | ||||||
key = "BU" | ||||||
value = "ConsumerProducts" | ||||||
} | ||||||
tags { | ||||||
key = "TeamName" | ||||||
value = "TeamA" | ||||||
} | ||||||
tags { | ||||||
key = "AppName" | ||||||
value = "ProductManagementApp" | ||||||
} | ||||||
tags { | ||||||
key = "Env" | ||||||
value = "Production" | ||||||
} | ||||||
tags { | ||||||
key = "Version" | ||||||
value = "8.0" | ||||||
} | ||||||
tags { | ||||||
key = "Email" | ||||||
value = "[email protected]" | ||||||
} | ||||||
} | ||||||
|
||||||
# Outputs to Display | ||||||
output "atlas_cluster_connection_string" { value = mongodbatlas_advanced_cluster.atlas-cluster.connection_strings.0.standard_srv } | ||||||
output "project_name" { value = mongodbatlas_project.atlas-project.name } | ||||||
|
||||||
# Set up an alert notification by email when there is replication lag | ||||||
# Greater than 1 hour for more than 5 minutes | ||||||
resource "mongodbatlas_alert_configuration" "test_replication_lag_alert" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
event_type = "OUTSIDE_METRIC_THRESHOLD" | ||||||
enabled = true | ||||||
|
||||||
notification { | ||||||
type_name = "GROUP" | ||||||
interval_min = 5 | ||||||
delay_min = 0 | ||||||
sms_enabled = false | ||||||
email_enabled = true | ||||||
roles = ["GROUP_CLUSTER_MANAGER"] | ||||||
} | ||||||
|
||||||
matcher { | ||||||
field_name = "CLUSTER_NAME" | ||||||
operator = "EQUALS" | ||||||
value = "myCluster" | ||||||
} | ||||||
|
||||||
metric_threshold_config { | ||||||
metric_name = "OPLOG_SLAVE_LAG_MASTER_TIME" | ||||||
operator = "GREATER_THAN" | ||||||
threshold = 1 | ||||||
units = "HOURS" | ||||||
} | ||||||
} | ||||||
|
||||||
# Atlas organization details to use in the configuration | ||||||
data "mongodbatlas_federated_settings" "this" { | ||||||
org_id = mongodbatlas_project.atlas-project.org_id | ||||||
} | ||||||
|
||||||
# Configure an identity provider for federated authentication | ||||||
# For IAM roles and Azure assigned identities, you must create the | ||||||
# role or identity and declare the variable before you use this | ||||||
# Terraform resource | ||||||
resource "mongodbatlas_federated_settings_identity_provider" "oidc" { | ||||||
federation_settings_id = data.mongodbatlas_federated_settings.this.id | ||||||
audience = var.token_audience | ||||||
authorization_type = "USER" | ||||||
description = "oidc-for-azure" | ||||||
# e.g. "https://sts.windows.net/91405384-d71e-47f5-92dd-759e272cdc1c/" | ||||||
issuer_uri = "https://sts.windows.net/${azurerm_user_assigned_identity.this.tenant_id}/" | ||||||
idp_type = "WORKLOAD" | ||||||
name = "OIDC-for-azure" | ||||||
protocol = "OIDC" | ||||||
# groups_claim = null | ||||||
user_claim = "sub" | ||||||
} | ||||||
|
||||||
resource "mongodbatlas_federated_settings_org_config" "this" { | ||||||
federation_settings_id = data.mongodbatlas_federated_settings.this.id | ||||||
org_id = mongodbatlas_project.atlas-project.org_id | ||||||
domain_restriction_enabled = false | ||||||
domain_allow_list = [] | ||||||
data_access_identity_provider_ids = [mongodbatlas_federated_settings_identity_provider.oidc.idp_id] | ||||||
} | ||||||
|
||||||
# Create an OIDC federated authentication user | ||||||
# For IAM roles and Azure assigned identities, you must create the | ||||||
# role or identity and declare the variable before you use this | ||||||
# Terraform resource | ||||||
resource "mongodbatlas_database_user" "oidc" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
username = "${mongodbatlas_federated_settings_identity_provider.oidc.idp_id}/${azurerm_user_assigned_identity.this.principal_id}" | ||||||
oidc_auth_type = "USER" | ||||||
auth_database_name = "$external" # required when using OIDC USER authentication | ||||||
|
||||||
roles { | ||||||
role_name = "atlasAdmin" | ||||||
database_name = "admin" | ||||||
} | ||||||
} | ||||||
|
||||||
# Configure a custom role | ||||||
resource "mongodbatlas_custom_db_role" "create_role" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
role_name = "my_custom_role" | ||||||
|
||||||
actions { | ||||||
action = "UPDATE" | ||||||
resources { | ||||||
database_name = "myDb" | ||||||
} | ||||||
} | ||||||
actions { | ||||||
action = "INSERT" | ||||||
resources { | ||||||
database_name = "myDb" | ||||||
} | ||||||
} | ||||||
actions { | ||||||
action = "REMOVE" | ||||||
resources { | ||||||
database_name = "myDb" | ||||||
} | ||||||
} | ||||||
} | ||||||
|
||||||
# AWS ONLY- remove for other cloud providers: Create a Private Link | ||||||
resource "mongodbatlas_privatelink_endpoint" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
provider_name = "AWS" | ||||||
region = "US_EAST_1" | ||||||
|
||||||
timeouts { | ||||||
create = "30m" | ||||||
delete = "20m" | ||||||
} | ||||||
} | ||||||
|
||||||
# AZURE ONLY- remove for other cloud providers: Create a Private Link | ||||||
resource "mongodbatlas_privatelink_endpoint" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
provider_name = "AZURE" | ||||||
region = "US_EAST_1" | ||||||
|
||||||
timeouts { | ||||||
create = "30m" | ||||||
delete = "20m" | ||||||
} | ||||||
} | ||||||
|
||||||
# AWS ONLY- remove for other cloud providers: Enable BYOK encryption | ||||||
resource "mongodbatlas_cloud_provider_access_setup" "setup_only" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
provider_name = "AWS" | ||||||
} | ||||||
|
||||||
# AWS ONLY- remove for other cloud providers: Enable BYOK encryption | ||||||
# For IAM roles and Azure assigned identities, you must create the | ||||||
# role or identity and declare the variable before you use this | ||||||
# Terraform resource | ||||||
resource "mongodbatlas_cloud_provider_access_authorization" "auth_role" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
role_id = mongodbatlas_cloud_provider_access_setup.setup_only.role_id | ||||||
|
||||||
aws { | ||||||
iam_assumed_role_arn = aws_iam_role.test_role.arn | ||||||
} | ||||||
} | ||||||
|
||||||
# AWS ONLY- remove for other cloud providers: Enable BYOK encryption | ||||||
# For KMS keys, you must create the | ||||||
# key and declare the variable before you use this | ||||||
# Terraform resource | ||||||
resource "mongodbatlas_encryption_at_rest" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
|
||||||
aws_kms_config { | ||||||
enabled = true | ||||||
customer_master_key_id = aws_kms_key.kms_key.id | ||||||
region = var.atlas_region | ||||||
role_id = mongodbatlas_cloud_provider_access_authorization.auth_role.role_id | ||||||
} | ||||||
} | ||||||
output "is_aws_kms_encryption_at_rest_valid" { | ||||||
value = data.mongodbatlas_project.atlas-project.id.aws_kms_config.valid | ||||||
} | ||||||
data "mongodbatlas_encryption_at_rest" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
} | ||||||
|
||||||
# AZURE ONLY- remove for other cloud providers: Enable BYOK encryption | ||||||
resource "mongodbatlas_encryption_at_rest" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
|
||||||
azure_key_vault_config { | ||||||
enabled = true | ||||||
azure_environment = "AZURE" | ||||||
|
||||||
tenant_id = var.azure_tenant_id | ||||||
subscription_id = var.azure_subscription_id | ||||||
client_id = var.azure_client_id | ||||||
secret = var.azure_client_secret | ||||||
|
||||||
resource_group_name = var.azure_resource_group_name | ||||||
key_vault_name = var.azure_key_vault_name | ||||||
key_identifier = var.azure_key_identifier | ||||||
} | ||||||
} | ||||||
output "is_azure_encryption_at_rest_valid" { | ||||||
value = data.mongodbatlas_encryption_at_rest.test.azure_key_vault_config.valid | ||||||
} | ||||||
|
||||||
#GCP ONLY- remove for other cloud providers: Enable BYOK encryption | ||||||
resource "mongodbatlas_encryption_at_rest" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
|
||||||
google_cloud_kms_config { | ||||||
enabled = true | ||||||
service_account_key = "{\"type\": \"service_account\",\"project_id\": \"my-project-common-0\",\"private_key_id\": \"e120598ea4f88249469fcdd75a9a785c1bb3\",\"private_key\": \"-----BEGIN PRIVATE KEY-----\\nMIIEuwIBA(truncated)SfecnS0mT94D9\\n-----END PRIVATE KEY-----\\n\",\"client_email\": \"[email protected]\",\"client_id\": \"10180967717292066\",\"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\"token_uri\": \"https://accounts.google.com/o/oauth2/token\",\"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\"client_x509_cert_url\": \"https://www.googleapis.com/robot/v1/metadata/x509/my-email-kms-0%40my-project-common-0.iam.gserviceaccount.com\"}" | ||||||
key_version_resource_id = "projects/my-project-common-0/locations/us-east4/keyRings/my-key-ring-0/cryptoKeys/my-key-0/cryptoKeyVersions/1" | ||||||
} | ||||||
} | ||||||
|
||||||
# Enable auditing and create an audit filter for your cluster | ||||||
resource "mongodbatlas_auditing" "test" { | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
audit_filter = "{ 'atype': 'authenticate', 'param': { 'user': 'auditAdmin', 'db': 'admin', 'mechanism': 'SCRAM-SHA-1' }}" | ||||||
audit_authorization_success = false | ||||||
enabled = true | ||||||
} | ||||||
|
||||||
# Configure backup schedule | ||||||
locals { | ||||||
atlas_clusters = { | ||||||
"cluster_1" = { name = "m10-aws-1e", region = "US_EAST_1" }, | ||||||
"cluster_2" = { name = "m10-aws-2e", region = "US_EAST_2" }, | ||||||
} | ||||||
} | ||||||
|
||||||
resource "mongodbatlas_advanced_cluster" "automated_backup_test_cluster" { | ||||||
for_each = local.atlas_clusters | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
name = each.value.name | ||||||
cluster_type = "REPLICASET" | ||||||
|
||||||
replication_specs { | ||||||
region_configs { | ||||||
electable_specs { | ||||||
instance_size = "M10" | ||||||
node_count = 3 | ||||||
} | ||||||
analytics_specs { | ||||||
instance_size = "M10" | ||||||
node_count = 1 | ||||||
} | ||||||
|
||||||
provider_name = "AWS" | ||||||
region_name = each.value.region | ||||||
priority = 7 | ||||||
} | ||||||
} | ||||||
|
||||||
backup_enabled = true # enable cloud backup snapshots | ||||||
pit_enabled = true | ||||||
} | ||||||
|
||||||
resource "mongodbatlas_cloud_backup_schedule" "test" { | ||||||
for_each = local.atlas_clusters | ||||||
project_id = mongodbatlas_project.atlas-project.id | ||||||
cluster_name = mongodbatlas_advanced_cluster.automated_backup_test_cluster[each.key].name | ||||||
reference_hour_of_day = 3 | ||||||
reference_minute_of_hour = 45 | ||||||
restore_window_days = 4 | ||||||
|
||||||
copy_settings { | ||||||
cloud_provider = "AWS" | ||||||
frequencies = ["HOURLY", | ||||||
"DAILY", | ||||||
"WEEKLY", | ||||||
"MONTHLY", | ||||||
"YEARLY", | ||||||
"ON_DEMAND"] | ||||||
region_name = "US_WEST_1" | ||||||
zone_id = mongodbatlas_advanced_cluster.automated_backup_test_cluster[each.key].replication_specs.*.zone_id[0] | ||||||
should_copy_oplogs = true | ||||||
} | ||||||
|
||||||
policy_item_hourly { | ||||||
frequency_interval = 1 #accepted values = 1, 2, 4, 6, 8, 12 -> every n hours | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit
Suggested change
|
||||||
retention_unit = "days" | ||||||
retention_value = 4 | ||||||
} | ||||||
policy_item_daily { | ||||||
frequency_interval = 1 #accepted values = 1 -> every 1 day | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit
Suggested change
|
||||||
retention_unit = "days" | ||||||
retention_value = 4 | ||||||
} | ||||||
policy_item_weekly { | ||||||
frequency_interval = 4 # accepted values = 1 to 7 -> every 1=Monday,2=Tuesday,3=Wednesday,4=Thursday,5=Friday,6=Saturday,7=Sunday day of the week | ||||||
retention_unit = "weeks" | ||||||
retention_value = 4 | ||||||
} | ||||||
policy_item_monthly { | ||||||
frequency_interval = 5 # accepted values = 1 to 28 -> 1 to 28 every nth day of the month | ||||||
# accepted values = 40 -> every last day of the month | ||||||
retention_unit = "months" | ||||||
retention_value = 4 | ||||||
} | ||||||
policy_item_yearly { | ||||||
frequency_interval = 1 # accepted values = 1 to 12 -> 1st day of nth month | ||||||
retention_unit = "years" | ||||||
retention_value = 4 | ||||||
} | ||||||
|
||||||
depends_on = [ | ||||||
mongodbatlas_advanced_cluster.automated_backup_test_cluster | ||||||
] | ||||||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this be removed?