From b4fab69382c87f4ac9df5a21f3d9ffe18794fd36 Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:05:33 +0200 Subject: [PATCH 1/6] redacted --- .../flex-upgrade/README.md | 14 +++++++------- .../tenant-upgrade/README.md | 8 ++++---- .../flex-upgrade/README.md | 14 +++++++------- .../tenant-upgrade/README.md | 8 ++++---- .../mongodbatlas_cluster/nvme-upgrade/README.md | 8 ++++---- .../mongodbatlas_cluster/tenant-upgrade/README.md | 8 ++++---- 6 files changed, 30 insertions(+), 30 deletions(-) diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md index fdcc4816c8..2e60b33feb 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md @@ -21,8 +21,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a free tier cluster: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -64,8 +64,8 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the free tier cluster you just created to flex tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "FLEX" backing_provider_name = "AWS" provider_instance_size_name = null @@ -107,8 +107,8 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the flex tier cluster you just created to dedicated tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" backing_provider_name = null provider_instance_size_name = "M10" @@ -145,4 +145,4 @@ resource "mongodbatlas_advanced_cluster" "cluster" { value = "dev" } } -``` \ No newline at end of file +``` diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md index af8e6b27a6..0ab5cbdc51 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md @@ -21,8 +21,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -31,7 +31,7 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md b/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md index 26c93c1a96..f703226fe8 100644 --- a/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md @@ -16,8 +16,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a free tier cluster: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -55,8 +55,8 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the free tier cluster you just created to flex tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "FLEX" backing_provider_name = "AWS" provider_instance_size_name = null @@ -93,8 +93,8 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the flex tier cluster you just created to dedicated tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" backing_provider_name = null provider_instance_size_name = "M10" @@ -126,4 +126,4 @@ resource "mongodbatlas_advanced_cluster" "cluster" { value = "dev" } } -``` \ No newline at end of file +``` diff --git a/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md b/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md index a2a5a4a0f0..690c5ff37a 100644 --- a/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md @@ -16,8 +16,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -26,7 +26,7 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` atlas_org_id = -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_cluster/nvme-upgrade/README.md b/examples/mongodbatlas_cluster/nvme-upgrade/README.md index 8e0fedb8b6..b6fab91fc1 100644 --- a/examples/mongodbatlas_cluster/nvme-upgrade/README.md +++ b/examples/mongodbatlas_cluster/nvme-upgrade/README.md @@ -21,8 +21,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M40" provider_volume_type = "STANDARD" @@ -32,8 +32,8 @@ provider_disk_iops = 3000 Apply with the following `terraform.tfvars` to upgrade the standard storage tier cluster you just created to provisioned storage NVME tier: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M40_NVME" provider_volume_type = "PROVISIONED" diff --git a/examples/mongodbatlas_cluster/tenant-upgrade/README.md b/examples/mongodbatlas_cluster/tenant-upgrade/README.md index 760e534d91..6c308efabc 100644 --- a/examples/mongodbatlas_cluster/tenant-upgrade/README.md +++ b/examples/mongodbatlas_cluster/tenant-upgrade/README.md @@ -18,8 +18,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -28,7 +28,7 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "GCP" provider_instance_size_name = "M10" From 83c168178d22870f2f344b4260da961c191fe6bc Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:17:31 +0200 Subject: [PATCH 2/6] use YOUR... for credential variables --- docs/index.md | 25 ++++++++++--------- .../module_user/README.md | 4 +-- .../asymmetric-sharded-cluster/README.md | 4 +-- .../auto-scaling-per-shard/README.md | 4 +-- .../global-cluster/README.md | 4 +-- .../multi-cloud/README.md | 4 +-- .../asymmetric-sharded-cluster/README.md | 4 +-- .../auto-scaling-per-shard/README.md | 4 +-- .../global-cluster/README.md | 4 +-- .../multi-cloud/README.md | 4 +-- .../README.md | 4 +-- .../aws/README.md | 8 +++--- .../azure/README.md | 4 +-- examples/mongodbatlas_database_user/Readme.md | 4 +-- .../aws/atlas-cluster/README.md | 4 +-- .../aws/multi-region-cluster/README.MD | 4 +-- .../README.md | 10 ++++---- .../azure/README.md | 4 +-- examples/mongodbatlas_organization/Readme.md | 8 +++--- .../organization-step-1/Readme.md | 4 +-- .../organization-step-2/Readme.md | 4 +-- .../aws/cluster-geosharded/README.md | 22 ++++++++-------- .../aws/cluster/README.md | 24 +++++++++--------- .../data-federation-online-archive/README.md | 22 ++++++++-------- .../README.md | 20 +++++++-------- .../datadog/README.md | 12 ++++----- .../prometheus-and-teams/Readme.md | 4 +-- examples/starter/Readme.md | 4 +-- 28 files changed, 114 insertions(+), 113 deletions(-) diff --git a/docs/index.md b/docs/index.md index 25072d816f..6c3dfd8b51 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,8 +59,9 @@ provider "mongodbatlas" {} Usage (prefix the export commands with a space to avoid the keys being recorded in OS history): ```shell -$ export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -$ export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +$ export MONGODB_ATLAS_PUBLIC_KEY="" +$ export MONGODB_ATLAS_PRIVATE_KEY="" +``` $ terraform plan ``` @@ -102,8 +103,8 @@ Note: this policy may be overly broad for many use cases, feel free to adjust ac 3. In terminal, store as environmental variables AWS API Keys (while you can also hardcode in config files these will then be stored as plain text in .tfstate file and should be avoided if possible). For example: ``` -export AWS_ACCESS_KEY_ID="secret" -export AWS_SECRET_ACCESS_KEY="secret” +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` 4. In terminal, use the AWS CLI command: `aws sts assume-role --role-arn ROLE_ARN_FROM_ABOVE --role-session-name newSession` @@ -111,9 +112,9 @@ Note: AWS STS secrets are short lived by default, use the ` --duration-seconds` 5. Store each of the 3 new created secrets from AWS STS as environment variables (hardcoding secrets into config file with additional risk is also supported). For example: ``` -export AWS_ACCESS_KEY_ID="ASIAYBYSK3S5FZEKLETV" -export AWS_SECRET_ACCESS_KEY="lgT6kL9lr1fxM6mCEwJ33MeoJ1M6lIzgsiW23FGH" -export AWS_SESSION_TOKEN="IQoXX3+Q" +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' +export AWS_SESSION_TOKEN="" ``` 6. Add assume_role block with `role_arn`, `secret_name`, and AWS `region` where secret is stored as part of AWS SM. Each of these 3 fields are REQUIRED. For example: @@ -121,15 +122,15 @@ export AWS_SESSION_TOKEN="IQoXX3+Q" # Configure the MongoDB Atlas Provider to Authenticate with AWS Secrets Manager provider "mongodbatlas" { assume_role { - role_arn = "arn:aws:iam::476xxx451:role/mdbsts" + role_arn = "arn:aws:iam:::role/mdbsts" } secret_name = "mongodbsecret" - // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1:553552370874:secret:test789-TO06Hy" + // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" region = "us-east-2" - aws_access_key_id = "ASIXXBNEK" - aws_secret_access_key = "ZUZgVb8XYZWEXXEDURGFHFc5Au" - aws_session_token = "IQoXX3+Q=" + aws_access_key_id = "" + aws_secret_access_key = "" + aws_session_token = "" sts_endpoint = "https://sts.us-east-2.amazonaws.com/" } ``` diff --git a/examples/migrate_cluster_to_advanced_cluster/module_user/README.md b/examples/migrate_cluster_to_advanced_cluster/module_user/README.md index 6f3bb4670a..a4e00f3022 100644 --- a/examples/migrate_cluster_to_advanced_cluster/module_user/README.md +++ b/examples/migrate_cluster_to_advanced_cluster/module_user/README.md @@ -32,8 +32,8 @@ The rest of this example is a step by step guide on how to migrate from `mongodb - Configure the provider (can also be done by configuring `public_key` and `private_key` in a `provider.tfvars`). ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ## Step 1: Create the `mongodbatlas_cluster` with `v1` of the module diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md index fc230d0cf6..8eed75812d 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md index e1f6086b63..114411e9c7 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md index 6a6794af41..e17cc0479f 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md index a9ec4e9c2f..680c979996 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md @@ -24,8 +24,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md b/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md index cf66c97e8e..cffe5936f8 100644 --- a/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md b/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md index 250f581e23..eb22455007 100644 --- a/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md +++ b/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md @@ -20,8 +20,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md index 80f023f2e0..14f4a64826 100644 --- a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md index 40f455fe0b..56e5f155a9 100644 --- a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md +++ b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_cloud_backup_schedule/README.md b/examples/mongodbatlas_cloud_backup_schedule/README.md index 97f6f949f3..ff4447de6b 100644 --- a/examples/mongodbatlas_cloud_backup_schedule/README.md +++ b/examples/mongodbatlas_cloud_backup_schedule/README.md @@ -20,8 +20,8 @@ Terraform v1.10.0 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_cloud_provider_access/aws/README.md b/examples/mongodbatlas_cloud_provider_access/aws/README.md index 02eae6be0f..f2d1c21b21 100644 --- a/examples/mongodbatlas_cloud_provider_access/aws/README.md +++ b/examples/mongodbatlas_cloud_provider_access/aws/README.md @@ -20,13 +20,13 @@ Terraform v1.5.2 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +$ export AWS_ACCESS_KEY_ID='' +$ export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. diff --git a/examples/mongodbatlas_cloud_provider_access/azure/README.md b/examples/mongodbatlas_cloud_provider_access/azure/README.md index 7693ca15b5..50c88bdb6c 100644 --- a/examples/mongodbatlas_cloud_provider_access/azure/README.md +++ b/examples/mongodbatlas_cloud_provider_access/azure/README.md @@ -49,8 +49,8 @@ XXXXX This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_database_user/Readme.md b/examples/mongodbatlas_database_user/Readme.md index 0290514aec..1c19c328d4 100644 --- a/examples/mongodbatlas_database_user/Readme.md +++ b/examples/mongodbatlas_database_user/Readme.md @@ -19,8 +19,8 @@ This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md index f3c104f821..f067800f08 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md +++ b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md @@ -21,8 +21,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD index 88771e727a..3526f271f3 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD +++ b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD @@ -21,8 +21,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_federated_database_instance/README.md b/examples/mongodbatlas_federated_database_instance/README.md index d4a89a198b..8020d304d0 100644 --- a/examples/mongodbatlas_federated_database_instance/README.md +++ b/examples/mongodbatlas_federated_database_instance/README.md @@ -21,13 +21,13 @@ Terraform v1.10.0 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` -``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +```bash +$ export AWS_SECRET_ACCESS_KEY="" +$ export AWS_ACCESS_KEY_ID="" ``` ... or the `~/.aws/credentials` file. diff --git a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md index 5ad2a0b74a..525a5cbd3a 100644 --- a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md +++ b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md @@ -128,8 +128,8 @@ XXXXX This can be done using environment variables: ```shell -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` **3\. TFVARS** diff --git a/examples/mongodbatlas_organization/Readme.md b/examples/mongodbatlas_organization/Readme.md index 8c19251b8d..e83c080976 100644 --- a/examples/mongodbatlas_organization/Readme.md +++ b/examples/mongodbatlas_organization/Readme.md @@ -25,8 +25,8 @@ This project aims to provide a very straight-forward example of setting up a Mon This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. @@ -80,8 +80,8 @@ org_public_key = "yqffje" This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_organization/organization-step-1/Readme.md b/examples/mongodbatlas_organization/organization-step-1/Readme.md index c9660bc121..4b6098aeef 100644 --- a/examples/mongodbatlas_organization/organization-step-1/Readme.md +++ b/examples/mongodbatlas_organization/organization-step-1/Readme.md @@ -22,8 +22,8 @@ This project aims to provide a very straight-forward example of setting up a Mon This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_organization/organization-step-2/Readme.md b/examples/mongodbatlas_organization/organization-step-2/Readme.md index 3b31f640cb..25b4e0cbf8 100644 --- a/examples/mongodbatlas_organization/organization-step-2/Readme.md +++ b/examples/mongodbatlas_organization/organization-step-2/Readme.md @@ -18,8 +18,8 @@ This project aims to provide a very straight-forward example of setting up Terra This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md index 60b16d1e2b..40ebc14301 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md @@ -20,13 +20,13 @@ Setup [regionalized private endpoints](https://www.mongodb.com/docs/atlas/securi This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +$ export AWS_ACCESS_KEY_ID='' +$ export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -34,17 +34,17 @@ $ export AWS_ACCESS_KEY_ID='your key id' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md index eb703bcc3e..832d827e7a 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md @@ -16,13 +16,13 @@ Setup private connection to a [MongoDB Atlas Cluster](https://www.mongodb.com/ba This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +$ export AWS_SECRET_ACCESS_KEY='' +$ export AWS_ACCESS_KEY_ID='' ``` ... or the `~/.aws/credentials` file. @@ -30,17 +30,17 @@ $ export AWS_ACCESS_KEY_ID='your key id' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" cluster_name = "aws-private-connection" ``` @@ -134,4 +134,4 @@ locals { output "connection_string" { value = length(local.connection_strings) > 0 ? local.connection_strings[0] : "" } -``` \ No newline at end of file +``` diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md index 45eba61a98..919314c98e 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md @@ -16,13 +16,13 @@ Setup private connection to a [Data Federation or Online Archive](https://www.mo This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +$ export AWS_ACCESS_KEY_ID='' +$ export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -30,17 +30,17 @@ $ export AWS_ACCESS_KEY_ID='your key id' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_push_based_log_export/README.md b/examples/mongodbatlas_push_based_log_export/README.md index d827357d50..69874dc413 100644 --- a/examples/mongodbatlas_push_based_log_export/README.md +++ b/examples/mongodbatlas_push_based_log_export/README.md @@ -21,13 +21,13 @@ Terraform v1.5.2 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +$ export AWS_ACCESS_KEY_ID='' +$ export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -35,15 +35,15 @@ $ export AWS_ACCESS_KEY_ID='your key id' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values. For example: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_third_party_integration/datadog/README.md b/examples/mongodbatlas_third_party_integration/datadog/README.md index 39ffef2e75..cdde93214d 100644 --- a/examples/mongodbatlas_third_party_integration/datadog/README.md +++ b/examples/mongodbatlas_third_party_integration/datadog/README.md @@ -14,16 +14,16 @@ This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -public_key = "" -private_key = "" -project_id = "" -datadog_api_key = "" +public_key = "" +private_key = "" +project_id = "" +datadog_api_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md b/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md index 4febdc19c9..eff5102f69 100644 --- a/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md +++ b/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md @@ -26,8 +26,8 @@ You can refer to the MongoDB Atlas documentation to know about the parameters th This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/starter/Readme.md b/examples/starter/Readme.md index e855faa776..2b3fc60cd2 100644 --- a/examples/starter/Readme.md +++ b/examples/starter/Readme.md @@ -26,8 +26,8 @@ You can refer to the MongoDB Atlas documentation to know about the region names This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="xxxx" -export MONGODB_ATLAS_PRIVATE_KEY="xxxx" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. From 25074b8d27af8683ef4519e8b8f8defdae67aeeb Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:38:54 +0200 Subject: [PATCH 3/6] more changes --- contributing/development-setup.md | 74 +++++++++---------- docs/index.md | 17 ++--- .../aws/README.md | 16 ++-- .../aws/atlas-cluster/README.md | 5 +- .../aws/multi-region-cluster/README.MD | 5 +- .../README.md | 16 ++-- .../aws/Readme.md | 9 +-- .../aws/cluster-geosharded/README.md | 4 +- .../aws/cluster/README.md | 4 +- .../data-federation-online-archive/README.md | 4 +- .../README.md | 4 +- 11 files changed, 77 insertions(+), 81 deletions(-) diff --git a/contributing/development-setup.md b/contributing/development-setup.md index 38d5643e21..aa44a13b7a 100644 --- a/contributing/development-setup.md +++ b/contributing/development-setup.md @@ -141,24 +141,24 @@ You must also configure the following environment variables before running the t - For `Authentication database user` resource configuration: ```bash - $ export MONGODB_ATLAS_DB_USERNAME= + export MONGODB_ATLAS_DB_USERNAME= ``` - For `Project(s)` resource configuration: ```bash - $ export MONGODB_ATLAS_TEAMS_IDS= + export MONGODB_ATLAS_TEAMS_IDS= ``` ~> **Notice:** It should be at least one team id up to 3 teams ids depending of acceptance testing using separator comma like this `teamId1,teamdId2,teamId3`. - For `Federated Settings` resource configuration: ```bash - $ export MONGODB_ATLAS_FEDERATION_SETTINGS_ID= - $ export ONGODB_ATLAS_FEDERATED_ORG_ID= - $ export MONGODB_ATLAS_FEDERATED_GROUP_ID= - $ export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID= - $ export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID= - $ export MONGODB_ATLAS_FEDERATED_SSO_URL= - $ export MONGODB_ATLAS_FEDERATED_ISSUER_URI= + export MONGODB_ATLAS_FEDERATION_SETTINGS_ID= + export ONGODB_ATLAS_FEDERATED_ORG_ID= + export MONGODB_ATLAS_FEDERATED_GROUP_ID= + export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID= + export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID= + export MONGODB_ATLAS_FEDERATED_SSO_URL= + export MONGODB_ATLAS_FEDERATED_ISSUER_URI= ``` ~> **Notice:** For more information about the Federation configuration resource, see: https://www.mongodb.com/docs/atlas/reference/api/federation-configuration/ @@ -166,38 +166,38 @@ You must also configure the following environment variables before running the t - For `Network Peering` resource configuration: ```bash - $ export AWS_ACCOUNT_ID= - $ export AWS_VPC_ID= - $ export AWS_VPC_CIDR_BLOCK= - $ export AWS_REGION= - $ export AWS_SUBNET_ID= - $ export AWS_SECURITY_GROUP_ID= + export AWS_ACCOUNT_ID= + export AWS_VPC_ID= + export AWS_VPC_CIDR_BLOCK= + export AWS_REGION= + export AWS_SUBNET_ID= + export AWS_SECURITY_GROUP_ID= ``` ~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/ - For `Encryption at Rest` resource configuration: ```bash - $ export AWS_ACCESS_KEY_ID= - $ export AWS_SECRET_ACCESS_KEY= - $ export AWS_CUSTOMER_MASTER_KEY_ID= - $ export AWS_REGION= - - $ export AWS_ACCESS_KEY_ID_UPDATED= - $ export AWS_SECRET_ACCESS_KEY_UPDATED= - $ export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED= - $ export AWS_REGION_UPDATED= + export AWS_ACCESS_KEY_ID= + export AWS_SECRET_ACCESS_KEY= + export AWS_CUSTOMER_MASTER_KEY_ID= + export AWS_REGION= + + export AWS_ACCESS_KEY_ID_UPDATED= + export AWS_SECRET_ACCESS_KEY_UPDATED= + export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED= + export AWS_REGION_UPDATED= ``` ~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/ - For `Private Endpoint Link` resource configuration: ```bash - $ export AWS_ACCESS_KEY_ID= - $ export AWS_SECRET_ACCESS_KEY= - $ export AWS_CUSTOMER_MASTER_KEY_ID= - $ export AWS_REGION= - $ export AWS_VPC_ID= - $ export AWS_SUBNET_ID= - $ export AWS_SECURITY_GROUP_ID= + export AWS_ACCESS_KEY_ID= + export AWS_SECRET_ACCESS_KEY= + export AWS_CUSTOMER_MASTER_KEY_ID= + export AWS_REGION= + export AWS_VPC_ID= + export AWS_SUBNET_ID= + export AWS_SECURITY_GROUP_ID= ``` ~> **Notice:** For more information about the PrivateLink (for AWS only), see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/https://docs.atlas.mongodb.com/reference/api/private-endpoint/ @@ -205,10 +205,10 @@ You must also configure the following environment variables before running the t - For `Network Peering` resource configuration: ```bash - $ export AZURE_DIRECTORY_ID= - $ export AZURE_SUBSCRIPTION_ID= - $ export AZURE_RESOURCE_GROUP_NAME= - $ export AZURE_VNET_NAME= + export AZURE_DIRECTORY_ID= + export AZURE_SUBSCRIPTION_ID= + export AZURE_RESOURCE_GROUP_NAME= + export AZURE_VNET_NAME= ``` ~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/ @@ -239,8 +239,8 @@ You must also configure the following environment variables before running the t - For Encryption at Rest resource configuration: ```bash - $ export GCP_SERVICE_ACCOUNT_KEY= - $ export GCP_KEY_VERSION_RESOURCE_ID= + export GCP_SERVICE_ACCOUNT_KEY= + export GCP_KEY_VERSION_RESOURCE_ID= ``` ~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/ diff --git a/docs/index.md b/docs/index.md index 6c3dfd8b51..bce0c8c7b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,7 +61,6 @@ Usage (prefix the export commands with a space to avoid the keys being recorded ```shell $ export MONGODB_ATLAS_PUBLIC_KEY="" $ export MONGODB_ATLAS_PRIVATE_KEY="" -``` $ terraform plan ``` @@ -103,8 +102,8 @@ Note: this policy may be overly broad for many use cases, feel free to adjust ac 3. In terminal, store as environmental variables AWS API Keys (while you can also hardcode in config files these will then be stored as plain text in .tfstate file and should be avoided if possible). For example: ``` -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` 4. In terminal, use the AWS CLI command: `aws sts assume-role --role-arn ROLE_ARN_FROM_ABOVE --role-session-name newSession` @@ -112,9 +111,9 @@ Note: AWS STS secrets are short lived by default, use the ` --duration-seconds` 5. Store each of the 3 new created secrets from AWS STS as environment variables (hardcoding secrets into config file with additional risk is also supported). For example: ``` -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' -export AWS_SESSION_TOKEN="" +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' +export AWS_SESSION_TOKEN="" ``` 6. Add assume_role block with `role_arn`, `secret_name`, and AWS `region` where secret is stored as part of AWS SM. Each of these 3 fields are REQUIRED. For example: @@ -128,9 +127,9 @@ provider "mongodbatlas" { // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" region = "us-east-2" - aws_access_key_id = "" - aws_secret_access_key = "" - aws_session_token = "" + aws_access_key_id = "" + aws_secret_access_key = "" + aws_session_token = "" sts_endpoint = "https://sts.us-east-2.amazonaws.com/" } ``` diff --git a/examples/mongodbatlas_cloud_provider_access/aws/README.md b/examples/mongodbatlas_cloud_provider_access/aws/README.md index f2d1c21b21..037b5ba3bc 100644 --- a/examples/mongodbatlas_cloud_provider_access/aws/README.md +++ b/examples/mongodbatlas_cloud_provider_access/aws/README.md @@ -25,8 +25,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_ACCESS_KEY_ID='' -$ export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -34,15 +34,15 @@ $ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md index f067800f08..d0f43fc4ec 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md +++ b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md @@ -38,9 +38,8 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID="exampleawsy" -export AWS_SECRET_ACCESS_KEY="ye3G3+example+TOez2BBK+P22+raXXn2l2hywcuq1" - +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` **3\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD index 3526f271f3..f32edafacb 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD +++ b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD @@ -38,9 +38,8 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID="exampleawsy" -export AWS_SECRET_ACCESS_KEY="ye3G3+example+TOez2BBK+P22+raXXn2l2hywcuq1" - +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` **3\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_federated_database_instance/README.md b/examples/mongodbatlas_federated_database_instance/README.md index 8020d304d0..511fefda43 100644 --- a/examples/mongodbatlas_federated_database_instance/README.md +++ b/examples/mongodbatlas_federated_database_instance/README.md @@ -26,8 +26,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ```bash -$ export AWS_SECRET_ACCESS_KEY="" -$ export AWS_ACCESS_KEY_ID="" +export AWS_SECRET_ACCESS_KEY="" +export AWS_ACCESS_KEY_ID="" ``` ... or the `~/.aws/credentials` file. @@ -35,15 +35,15 @@ $ export AWS_ACCESS_KEY_ID="" ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Create an S3 bucket into your AWS account** Now create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_network_peering/aws/Readme.md b/examples/mongodbatlas_network_peering/aws/Readme.md index 43975c36e1..76524ddb1e 100644 --- a/examples/mongodbatlas_network_peering/aws/Readme.md +++ b/examples/mongodbatlas_network_peering/aws/Readme.md @@ -19,8 +19,8 @@ on darwin_amd64 This can be done using environment variables: ``` bash -$ export AWS_SECRET_ACCESS_KEY='your secret key' -$ export AWS_ACCESS_KEY_ID='your key id' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -28,9 +28,8 @@ $ export AWS_ACCESS_KEY_ID='your key id' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = your key id -aws_secret_access_key = your secret key - +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md index 40ebc14301..59df3a7e6d 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md @@ -25,8 +25,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_ACCESS_KEY_ID='' -$ export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md index 832d827e7a..8e3d59cfd9 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md @@ -21,8 +21,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_SECRET_ACCESS_KEY='' -$ export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' ``` ... or the `~/.aws/credentials` file. diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md index 919314c98e..62a515673a 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md @@ -21,8 +21,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_ACCESS_KEY_ID='' -$ export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. diff --git a/examples/mongodbatlas_push_based_log_export/README.md b/examples/mongodbatlas_push_based_log_export/README.md index 69874dc413..b300dcbdd5 100644 --- a/examples/mongodbatlas_push_based_log_export/README.md +++ b/examples/mongodbatlas_push_based_log_export/README.md @@ -26,8 +26,8 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -$ export AWS_ACCESS_KEY_ID='' -$ export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. From e1c5790a6a7ead35b7064b07a88b0135542598a5 Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 10:43:16 +0200 Subject: [PATCH 4/6] account id --- contributing/development-setup.md | 2 +- docs/guides/0.9.1-upgrade-guide.md | 4 ++-- docs/index.md | 4 ++-- docs/resources/cloud_provider_access.md | 2 +- docs/resources/stream_connection.md | 2 +- examples/mongodbatlas_stream_connection/main.tf | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/contributing/development-setup.md b/contributing/development-setup.md index aa44a13b7a..58a3e5e251 100644 --- a/contributing/development-setup.md +++ b/contributing/development-setup.md @@ -153,7 +153,7 @@ You must also configure the following environment variables before running the t - For `Federated Settings` resource configuration: ```bash export MONGODB_ATLAS_FEDERATION_SETTINGS_ID= - export ONGODB_ATLAS_FEDERATED_ORG_ID= + export MONGODB_ATLAS_FEDERATED_ORG_ID= export MONGODB_ATLAS_FEDERATED_GROUP_ID= export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID= export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID= diff --git a/docs/guides/0.9.1-upgrade-guide.md b/docs/guides/0.9.1-upgrade-guide.md index 093bd52671..a861de4a23 100644 --- a/docs/guides/0.9.1-upgrade-guide.md +++ b/docs/guides/0.9.1-upgrade-guide.md @@ -35,7 +35,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth" { role_id = mongodbatlas_cloud_provider_access_setup.unique.role_id aws = { - iam_assumed_role_arn = "arn:aws:iam::772401394250:role/test-user-role" + iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" } } ``` @@ -125,4 +125,4 @@ Warning: this resource is deprecated, please transition as soon as possible to m * [Request Features](https://feedback.mongodb.com/forums/924145-atlas?category_id=370723) -* [Contact Support](https://docs.atlas.mongodb.com/support/) covered by MongoDB Atlas support plans, Developer and above. \ No newline at end of file +* [Contact Support](https://docs.atlas.mongodb.com/support/) covered by MongoDB Atlas support plans, Developer and above. diff --git a/docs/index.md b/docs/index.md index bce0c8c7b5..4746ace2c2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -121,10 +121,10 @@ export AWS_SESSION_TOKEN="" # Configure the MongoDB Atlas Provider to Authenticate with AWS Secrets Manager provider "mongodbatlas" { assume_role { - role_arn = "arn:aws:iam:::role/mdbsts" + role_arn = "arn:aws:iam:::role/mdbsts" } secret_name = "mongodbsecret" - // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" + // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" region = "us-east-2" aws_access_key_id = "" diff --git a/docs/resources/cloud_provider_access.md b/docs/resources/cloud_provider_access.md index 293da3b455..c201286964 100644 --- a/docs/resources/cloud_provider_access.md +++ b/docs/resources/cloud_provider_access.md @@ -93,7 +93,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth_role" { role_id = mongodbatlas_cloud_provider_access_setup.setup_only.role_id aws { - iam_assumed_role_arn = "arn:aws:iam::772401394250:role/test-user-role" + iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" } } diff --git a/docs/resources/stream_connection.md b/docs/resources/stream_connection.md index 5a44a850a6..df1fa89420 100644 --- a/docs/resources/stream_connection.md +++ b/docs/resources/stream_connection.md @@ -75,7 +75,7 @@ resource "mongodbatlas_stream_connection" "test" { connection_name = "AWSLambdaConnection" type = "AWSLambda" aws = { - role_arn = "arn:aws:iam::123456789123:role/lambdaRole" + role_arn = "arn:aws:iam:::role/lambdaRole" } } diff --git a/examples/mongodbatlas_stream_connection/main.tf b/examples/mongodbatlas_stream_connection/main.tf index e2e4ce52a1..8c0fa8a7ba 100644 --- a/examples/mongodbatlas_stream_connection/main.tf +++ b/examples/mongodbatlas_stream_connection/main.tf @@ -76,7 +76,7 @@ resource "mongodbatlas_stream_connection" "example-aws-lambda" { connection_name = "AWSLambdaConnection" type = "AWSLambda" aws = { - role_arn = "arn:aws:iam::123456789123:role/lambdaRole" + role_arn = "arn:aws:iam:::role/lambdaRole" } } @@ -110,4 +110,4 @@ output "stream_connection_bootstrap_servers" { output "stream_connection_total_count" { value = data.mongodbatlas_stream_connections.example.total_count -} \ No newline at end of file +} From 7d2902cf8e6f218412abfefb12bc61e237dbbc1e Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 12:09:25 +0200 Subject: [PATCH 5/6] remove YOUR_ --- contributing/development-setup.md | 105 +++++++++--------- docs/guides/0.9.1-upgrade-guide.md | 2 +- docs/index.md | 24 ++-- docs/resources/cloud_provider_access.md | 2 +- docs/resources/stream_connection.md | 2 +- .../module_user/README.md | 4 +- .../asymmetric-sharded-cluster/README.md | 4 +- .../auto-scaling-per-shard/README.md | 4 +- .../flex-upgrade/README.md | 18 +-- .../global-cluster/README.md | 4 +- .../multi-cloud/README.md | 4 +- .../tenant-upgrade/README.md | 12 +- .../asymmetric-sharded-cluster/README.md | 4 +- .../auto-scaling-per-shard/README.md | 4 +- .../flex-upgrade/README.md | 18 +-- .../global-cluster/README.md | 4 +- .../multi-cloud/README.md | 4 +- .../tenant-upgrade/README.md | 12 +- .../README.md | 4 +- .../aws/README.md | 20 ++-- .../azure/README.md | 4 +- .../nvme-upgrade/README.md | 8 +- .../tenant-upgrade/README.md | 8 +- examples/mongodbatlas_database_user/Readme.md | 4 +- .../aws/atlas-cluster/README.md | 8 +- .../aws/multi-region-cluster/README.MD | 8 +- .../README.md | 20 ++-- .../azure/README.md | 8 +- .../aws/Readme.md | 8 +- examples/mongodbatlas_organization/Readme.md | 8 +- .../organization-step-1/Readme.md | 4 +- .../organization-step-2/Readme.md | 4 +- .../aws/cluster-geosharded/README.md | 22 ++-- .../aws/cluster/README.md | 22 ++-- .../data-federation-online-archive/README.md | 22 ++-- .../README.md | 20 ++-- .../mongodbatlas_stream_connection/main.tf | 2 +- .../datadog/README.md | 12 +- .../prometheus-and-teams/Readme.md | 4 +- examples/starter/Readme.md | 4 +- 40 files changed, 227 insertions(+), 228 deletions(-) diff --git a/contributing/development-setup.md b/contributing/development-setup.md index 58a3e5e251..863aaf4212 100644 --- a/contributing/development-setup.md +++ b/contributing/development-setup.md @@ -130,10 +130,10 @@ You must also configure the following environment variables before running the t ##### MongoDB Atlas env variables - Required env variables: ```bash - export MONGODB_ATLAS_PROJECT_ID= - export MONGODB_ATLAS_ORG_ID= - export MONGODB_ATLAS_PUBLIC_KEY= - export MONGODB_ATLAS_PRIVATE_KEY= + export MONGODB_ATLAS_PUBLIC_KEY= + export MONGODB_ATLAS_PRIVATE_KEY= + export MONGODB_ATLAS_ORG_ID= + export MONGODB_ATLAS_PROJECT_ID= # This env variable is optional and allow you to run terraform with a custom server export MONGODB_ATLAS_BASE_URL= @@ -141,24 +141,24 @@ You must also configure the following environment variables before running the t - For `Authentication database user` resource configuration: ```bash - export MONGODB_ATLAS_DB_USERNAME= + export MONGODB_ATLAS_DB_USERNAME= ``` - For `Project(s)` resource configuration: ```bash - export MONGODB_ATLAS_TEAMS_IDS= + export MONGODB_ATLAS_TEAMS_IDS= ``` ~> **Notice:** It should be at least one team id up to 3 teams ids depending of acceptance testing using separator comma like this `teamId1,teamdId2,teamId3`. - For `Federated Settings` resource configuration: ```bash - export MONGODB_ATLAS_FEDERATION_SETTINGS_ID= - export MONGODB_ATLAS_FEDERATED_ORG_ID= - export MONGODB_ATLAS_FEDERATED_GROUP_ID= - export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID= - export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID= - export MONGODB_ATLAS_FEDERATED_SSO_URL= - export MONGODB_ATLAS_FEDERATED_ISSUER_URI= + export MONGODB_ATLAS_FEDERATION_SETTINGS_ID= + export MONGODB_ATLAS_FEDERATED_ORG_ID= + export MONGODB_ATLAS_FEDERATED_GROUP_ID= + export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID= + export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID= + export MONGODB_ATLAS_FEDERATED_SSO_URL= + export MONGODB_ATLAS_FEDERATED_ISSUER_URI= ``` ~> **Notice:** For more information about the Federation configuration resource, see: https://www.mongodb.com/docs/atlas/reference/api/federation-configuration/ @@ -166,38 +166,38 @@ You must also configure the following environment variables before running the t - For `Network Peering` resource configuration: ```bash - export AWS_ACCOUNT_ID= - export AWS_VPC_ID= - export AWS_VPC_CIDR_BLOCK= - export AWS_REGION= - export AWS_SUBNET_ID= - export AWS_SECURITY_GROUP_ID= + export AWS_ACCOUNT_ID= + export AWS_VPC_ID= + export AWS_VPC_CIDR_BLOCK= + export AWS_REGION= + export AWS_SUBNET_ID= + export AWS_SECURITY_GROUP_ID= ``` ~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/ - For `Encryption at Rest` resource configuration: ```bash - export AWS_ACCESS_KEY_ID= - export AWS_SECRET_ACCESS_KEY= - export AWS_CUSTOMER_MASTER_KEY_ID= - export AWS_REGION= - - export AWS_ACCESS_KEY_ID_UPDATED= - export AWS_SECRET_ACCESS_KEY_UPDATED= - export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED= - export AWS_REGION_UPDATED= + export AWS_ACCESS_KEY_ID= + export AWS_SECRET_ACCESS_KEY= + export AWS_CUSTOMER_MASTER_KEY_ID= + export AWS_REGION= + + export AWS_ACCESS_KEY_ID_UPDATED= + export AWS_SECRET_ACCESS_KEY_UPDATED= + export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED= + export AWS_REGION_UPDATED= ``` ~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/ - For `Private Endpoint Link` resource configuration: ```bash - export AWS_ACCESS_KEY_ID= - export AWS_SECRET_ACCESS_KEY= - export AWS_CUSTOMER_MASTER_KEY_ID= - export AWS_REGION= - export AWS_VPC_ID= - export AWS_SUBNET_ID= - export AWS_SECURITY_GROUP_ID= + export AWS_ACCESS_KEY_ID= + export AWS_SECRET_ACCESS_KEY= + export AWS_CUSTOMER_MASTER_KEY_ID= + export AWS_REGION= + export AWS_VPC_ID= + export AWS_SUBNET_ID= + export AWS_SECURITY_GROUP_ID= ``` ~> **Notice:** For more information about the PrivateLink (for AWS only), see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/https://docs.atlas.mongodb.com/reference/api/private-endpoint/ @@ -205,42 +205,41 @@ You must also configure the following environment variables before running the t - For `Network Peering` resource configuration: ```bash - export AZURE_DIRECTORY_ID= - export AZURE_SUBSCRIPTION_ID= - export AZURE_RESOURCE_GROUP_NAME= - export AZURE_VNET_NAME= + export AZURE_DIRECTORY_ID= + export AZURE_SUBSCRIPTION_ID= + export AZURE_RESOURCE_GROUP_NAME= + export AZURE_VNET_NAME= ``` ~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/ - For Encryption at Rest resource configuration: ```bash - export AZURE_CLIENT_ID= - export AZURE_SUBSCRIPTION_ID= - export AZURE_RESOURCE_GROUP_NAME= - export AZURE_APP_SECRET= - export AZURE_KEY_VAULT_NAME= - export AZURE_KEY_IDENTIFIER= - export AZURE_TENANT_ID= - export AZURE_DIRECTORY_ID= - - export AZURE_KEY_VAULT_NAME_UPDATED= - export AZURE_KEY_IDENTIFIER_UPDATED= + export AZURE_CLIENT_ID= + export AZURE_SUBSCRIPTION_ID= + export AZURE_RESOURCE_GROUP_NAME= + export AZURE_APP_SECRET= + export AZURE_KEY_VAULT_NAME= + export AZURE_KEY_IDENTIFIER= + export AZURE_TENANT_ID= + export AZURE_DIRECTORY_ID= + export AZURE_KEY_VAULT_NAME_UPDATED= + export AZURE_KEY_IDENTIFIER_UPDATED= ``` ~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/ ##### GCP env variables - For `Network Peering` resource configuration: ```bash - $export GCP_PROJECT_ID= + $export GCP_PROJECT_ID= ``` ~> **Notice:** For more information about the Network Peering resource, see: https://docs.atlas.mongodb.com/reference/api/vpc/ - For Encryption at Rest resource configuration: ```bash - export GCP_SERVICE_ACCOUNT_KEY= - export GCP_KEY_VERSION_RESOURCE_ID= + export GCP_SERVICE_ACCOUNT_KEY= + export GCP_KEY_VERSION_RESOURCE_ID= ``` ~> **Notice:** For more information about the Encryption at Rest resource, see: https://docs.atlas.mongodb.com/reference/api/encryption-at-rest/ diff --git a/docs/guides/0.9.1-upgrade-guide.md b/docs/guides/0.9.1-upgrade-guide.md index a861de4a23..68f89a77f9 100644 --- a/docs/guides/0.9.1-upgrade-guide.md +++ b/docs/guides/0.9.1-upgrade-guide.md @@ -35,7 +35,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth" { role_id = mongodbatlas_cloud_provider_access_setup.unique.role_id aws = { - iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" + iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" } } ``` diff --git a/docs/index.md b/docs/index.md index 4746ace2c2..ad655bdcba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -59,8 +59,8 @@ provider "mongodbatlas" {} Usage (prefix the export commands with a space to avoid the keys being recorded in OS history): ```shell -$ export MONGODB_ATLAS_PUBLIC_KEY="" -$ export MONGODB_ATLAS_PRIVATE_KEY="" +$ export MONGODB_ATLAS_PUBLIC_KEY="" +$ export MONGODB_ATLAS_PRIVATE_KEY="" $ terraform plan ``` @@ -102,8 +102,8 @@ Note: this policy may be overly broad for many use cases, feel free to adjust ac 3. In terminal, store as environmental variables AWS API Keys (while you can also hardcode in config files these will then be stored as plain text in .tfstate file and should be avoided if possible). For example: ``` -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` 4. In terminal, use the AWS CLI command: `aws sts assume-role --role-arn ROLE_ARN_FROM_ABOVE --role-session-name newSession` @@ -111,9 +111,9 @@ Note: AWS STS secrets are short lived by default, use the ` --duration-seconds` 5. Store each of the 3 new created secrets from AWS STS as environment variables (hardcoding secrets into config file with additional risk is also supported). For example: ``` -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' -export AWS_SESSION_TOKEN="" +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' +export AWS_SESSION_TOKEN="" ``` 6. Add assume_role block with `role_arn`, `secret_name`, and AWS `region` where secret is stored as part of AWS SM. Each of these 3 fields are REQUIRED. For example: @@ -121,15 +121,15 @@ export AWS_SESSION_TOKEN="" # Configure the MongoDB Atlas Provider to Authenticate with AWS Secrets Manager provider "mongodbatlas" { assume_role { - role_arn = "arn:aws:iam:::role/mdbsts" + role_arn = "arn:aws:iam:::role/mdbsts" } secret_name = "mongodbsecret" - // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" + // fully qualified secret_name ARN also supported as input "arn:aws:secretsmanager:af-south-1::secret:test789-TO06Hy" region = "us-east-2" - aws_access_key_id = "" - aws_secret_access_key = "" - aws_session_token = "" + aws_access_key_id = "" + aws_secret_access_key = "" + aws_session_token = "" sts_endpoint = "https://sts.us-east-2.amazonaws.com/" } ``` diff --git a/docs/resources/cloud_provider_access.md b/docs/resources/cloud_provider_access.md index c201286964..539cf0568f 100644 --- a/docs/resources/cloud_provider_access.md +++ b/docs/resources/cloud_provider_access.md @@ -93,7 +93,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth_role" { role_id = mongodbatlas_cloud_provider_access_setup.setup_only.role_id aws { - iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" + iam_assumed_role_arn = "arn:aws:iam:::role/test-user-role" } } diff --git a/docs/resources/stream_connection.md b/docs/resources/stream_connection.md index df1fa89420..52e41cd156 100644 --- a/docs/resources/stream_connection.md +++ b/docs/resources/stream_connection.md @@ -75,7 +75,7 @@ resource "mongodbatlas_stream_connection" "test" { connection_name = "AWSLambdaConnection" type = "AWSLambda" aws = { - role_arn = "arn:aws:iam:::role/lambdaRole" + role_arn = "arn:aws:iam:::role/lambdaRole" } } diff --git a/examples/migrate_cluster_to_advanced_cluster/module_user/README.md b/examples/migrate_cluster_to_advanced_cluster/module_user/README.md index a4e00f3022..a66c96b486 100644 --- a/examples/migrate_cluster_to_advanced_cluster/module_user/README.md +++ b/examples/migrate_cluster_to_advanced_cluster/module_user/README.md @@ -32,8 +32,8 @@ The rest of this example is a step by step guide on how to migrate from `mongodb - Configure the provider (can also be done by configuring `public_key` and `private_key` in a `provider.tfvars`). ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ## Step 1: Create the `mongodbatlas_cluster` with `v1` of the module diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md index 8eed75812d..eb897cfc36 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/asymmetric-sharded-cluster/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md index 114411e9c7..58b25ea53f 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/auto-scaling-per-shard/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md index 2e60b33feb..b43738f271 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/flex-upgrade/README.md @@ -20,9 +20,9 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a free tier cluster: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -63,9 +63,9 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the free tier cluster you just created to flex tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "FLEX" backing_provider_name = "AWS" provider_instance_size_name = null @@ -106,9 +106,9 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the flex tier cluster you just created to dedicated tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "AWS" backing_provider_name = null provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md index e17cc0479f..441fdc43d8 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/global-cluster/README.md @@ -23,8 +23,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md index 680c979996..454faeefe6 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/multi-cloud/README.md @@ -24,8 +24,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md index 0ab5cbdc51..81dc6b9c4e 100644 --- a/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster (preview provider 2.0.0)/tenant-upgrade/README.md @@ -20,9 +20,9 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -30,8 +30,8 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md b/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md index cffe5936f8..fb2d7af91c 100644 --- a/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster/asymmetric-sharded-cluster/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md b/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md index eb22455007..7223995f99 100644 --- a/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md +++ b/examples/mongodbatlas_advanced_cluster/auto-scaling-per-shard/README.md @@ -20,8 +20,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md b/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md index f703226fe8..20acc5096a 100644 --- a/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster/flex-upgrade/README.md @@ -15,9 +15,9 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a free tier cluster: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -54,9 +54,9 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the free tier cluster you just created to flex tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "FLEX" backing_provider_name = "AWS" provider_instance_size_name = null @@ -92,9 +92,9 @@ resource "mongodbatlas_advanced_cluster" "cluster" { Apply with the following `terraform.tfvars` to upgrade the flex tier cluster you just created to dedicated tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "AWS" backing_provider_name = null provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md index 14f4a64826..79b5b8026e 100644 --- a/examples/mongodbatlas_advanced_cluster/global-cluster/README.md +++ b/examples/mongodbatlas_advanced_cluster/global-cluster/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md index 56e5f155a9..1713deedef 100644 --- a/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md +++ b/examples/mongodbatlas_advanced_cluster/multi-cloud/README.md @@ -19,8 +19,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md b/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md index 690c5ff37a..21a5ee78b1 100644 --- a/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md +++ b/examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md @@ -15,9 +15,9 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -25,8 +25,8 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` -atlas_org_id = -public_key = -private_key = +atlas_org_id = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_cloud_backup_schedule/README.md b/examples/mongodbatlas_cloud_backup_schedule/README.md index ff4447de6b..1510ee174c 100644 --- a/examples/mongodbatlas_cloud_backup_schedule/README.md +++ b/examples/mongodbatlas_cloud_backup_schedule/README.md @@ -20,8 +20,8 @@ Terraform v1.10.0 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_cloud_provider_access/aws/README.md b/examples/mongodbatlas_cloud_provider_access/aws/README.md index 037b5ba3bc..23c68cc602 100644 --- a/examples/mongodbatlas_cloud_provider_access/aws/README.md +++ b/examples/mongodbatlas_cloud_provider_access/aws/README.md @@ -20,13 +20,13 @@ Terraform v1.5.2 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -34,15 +34,15 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_cloud_provider_access/azure/README.md b/examples/mongodbatlas_cloud_provider_access/azure/README.md index 50c88bdb6c..dc9534a309 100644 --- a/examples/mongodbatlas_cloud_provider_access/azure/README.md +++ b/examples/mongodbatlas_cloud_provider_access/azure/README.md @@ -49,8 +49,8 @@ XXXXX This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: diff --git a/examples/mongodbatlas_cluster/nvme-upgrade/README.md b/examples/mongodbatlas_cluster/nvme-upgrade/README.md index b6fab91fc1..898cbe260f 100644 --- a/examples/mongodbatlas_cluster/nvme-upgrade/README.md +++ b/examples/mongodbatlas_cluster/nvme-upgrade/README.md @@ -21,8 +21,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M40" provider_volume_type = "STANDARD" @@ -32,8 +32,8 @@ provider_disk_iops = 3000 Apply with the following `terraform.tfvars` to upgrade the standard storage tier cluster you just created to provisioned storage NVME tier: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "AWS" provider_instance_size_name = "M40_NVME" provider_volume_type = "PROVISIONED" diff --git a/examples/mongodbatlas_cluster/tenant-upgrade/README.md b/examples/mongodbatlas_cluster/tenant-upgrade/README.md index 6c308efabc..25e6e5d3de 100644 --- a/examples/mongodbatlas_cluster/tenant-upgrade/README.md +++ b/examples/mongodbatlas_cluster/tenant-upgrade/README.md @@ -18,8 +18,8 @@ Utilize the following to execute a working example, replacing the org id, public Apply with the following `terraform.tfvars` to first create a shared tier cluster: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "TENANT" backing_provider_name = "AWS" provider_instance_size_name = "M0" @@ -28,7 +28,7 @@ provider_instance_size_name = "M0" Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier: ``` atlas_org_id = "627a9687f7f7f7f774de306f14" -public_key = -private_key = +public_key = +private_key = provider_name = "GCP" provider_instance_size_name = "M10" diff --git a/examples/mongodbatlas_database_user/Readme.md b/examples/mongodbatlas_database_user/Readme.md index 1c19c328d4..88c9a52319 100644 --- a/examples/mongodbatlas_database_user/Readme.md +++ b/examples/mongodbatlas_database_user/Readme.md @@ -19,8 +19,8 @@ This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md index d0f43fc4ec..105c40b195 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md +++ b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md @@ -21,8 +21,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: @@ -38,8 +38,8 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` **3\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD index f32edafacb..52bb6f58e5 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD +++ b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD @@ -21,8 +21,8 @@ Terraform >= 0.13 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: @@ -38,8 +38,8 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` **3\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_federated_database_instance/README.md b/examples/mongodbatlas_federated_database_instance/README.md index 511fefda43..abf5309688 100644 --- a/examples/mongodbatlas_federated_database_instance/README.md +++ b/examples/mongodbatlas_federated_database_instance/README.md @@ -21,13 +21,13 @@ Terraform v1.10.0 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ```bash -export AWS_SECRET_ACCESS_KEY="" -export AWS_ACCESS_KEY_ID="" +export AWS_SECRET_ACCESS_KEY="" +export AWS_ACCESS_KEY_ID="" ``` ... or the `~/.aws/credentials` file. @@ -35,15 +35,15 @@ export AWS_ACCESS_KEY_ID="" ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Create an S3 bucket into your AWS account** Now create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md index 525a5cbd3a..2f70ef1eb8 100644 --- a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md +++ b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md @@ -128,8 +128,8 @@ XXXXX This can be done using environment variables: ```shell -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` **3\. TFVARS** @@ -140,7 +140,7 @@ Create a file named `vars.auto.tfvars` project_name = "tf-example-oidc" location = "eastus" # Azure region owner = "my-user" -org_id = "YOUR_ATLAS_ORG_ID" # e.g 65def6ce0f722a1507105aa5 +org_id = "ATLAS_ORG_ID" # e.g 65def6ce0f722a1507105aa5 region = "US_EAST_1" # Atlas region insert_record_database = "test" insert_record_collection = "test" @@ -151,7 +151,7 @@ Configuring the `ssh_public_key` for the Azure VM: ```shell cd ~/.ssh -ssh-keygen -t rsa -b 4096 -C "" # to generate a keypair for the VM +ssh-keygen -t rsa -b 4096 -C "" # to generate a keypair for the VM export TF_VAR_ssh_public_key=$(cat ~/.ssh/id_rsa.pub) # set the `ssh_public_key` with an env var instead of using the variable ``` diff --git a/examples/mongodbatlas_network_peering/aws/Readme.md b/examples/mongodbatlas_network_peering/aws/Readme.md index 76524ddb1e..1f775c7f3a 100644 --- a/examples/mongodbatlas_network_peering/aws/Readme.md +++ b/examples/mongodbatlas_network_peering/aws/Readme.md @@ -19,8 +19,8 @@ on darwin_amd64 This can be done using environment variables: ``` bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -28,8 +28,8 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_organization/Readme.md b/examples/mongodbatlas_organization/Readme.md index e83c080976..1be9f715ba 100644 --- a/examples/mongodbatlas_organization/Readme.md +++ b/examples/mongodbatlas_organization/Readme.md @@ -25,8 +25,8 @@ This project aims to provide a very straight-forward example of setting up a Mon This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. @@ -80,8 +80,8 @@ org_public_key = "yqffje" This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_organization/organization-step-1/Readme.md b/examples/mongodbatlas_organization/organization-step-1/Readme.md index 4b6098aeef..2407bc124e 100644 --- a/examples/mongodbatlas_organization/organization-step-1/Readme.md +++ b/examples/mongodbatlas_organization/organization-step-1/Readme.md @@ -22,8 +22,8 @@ This project aims to provide a very straight-forward example of setting up a Mon This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_organization/organization-step-2/Readme.md b/examples/mongodbatlas_organization/organization-step-2/Readme.md index 25b4e0cbf8..ac543ad08a 100644 --- a/examples/mongodbatlas_organization/organization-step-2/Readme.md +++ b/examples/mongodbatlas_organization/organization-step-2/Readme.md @@ -18,8 +18,8 @@ This project aims to provide a very straight-forward example of setting up Terra This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or utilize the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md index 59df3a7e6d..e011fdf555 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md @@ -20,13 +20,13 @@ Setup [regionalized private endpoints](https://www.mongodb.com/docs/atlas/securi This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -34,17 +34,17 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md index 8e3d59cfd9..4afa05f7ee 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md @@ -16,13 +16,13 @@ Setup private connection to a [MongoDB Atlas Cluster](https://www.mongodb.com/ba This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_SECRET_ACCESS_KEY='' -export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' ``` ... or the `~/.aws/credentials` file. @@ -30,17 +30,17 @@ export AWS_ACCESS_KEY_ID='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" cluster_name = "aws-private-connection" ``` diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md index 62a515673a..50a496422f 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md @@ -16,13 +16,13 @@ Setup private connection to a [Data Federation or Online Archive](https://www.mo This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -30,17 +30,17 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" -project_id = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" +project_id = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_push_based_log_export/README.md b/examples/mongodbatlas_push_based_log_export/README.md index b300dcbdd5..d9363a33bb 100644 --- a/examples/mongodbatlas_push_based_log_export/README.md +++ b/examples/mongodbatlas_push_based_log_export/README.md @@ -21,13 +21,13 @@ Terraform v1.5.2 This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' -export AWS_SECRET_ACCESS_KEY='' +export AWS_ACCESS_KEY_ID='' +export AWS_SECRET_ACCESS_KEY='' ``` ... or the `~/.aws/credentials` file. @@ -35,15 +35,15 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = -aws_secret_access_key = +aws_access_key_id = +aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values. For example: ``` -access_key = "" -secret_key = "" -public_key = "" -private_key = "" +access_key = "" +secret_key = "" +public_key = "" +private_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_stream_connection/main.tf b/examples/mongodbatlas_stream_connection/main.tf index 8c0fa8a7ba..c6e2eb413c 100644 --- a/examples/mongodbatlas_stream_connection/main.tf +++ b/examples/mongodbatlas_stream_connection/main.tf @@ -76,7 +76,7 @@ resource "mongodbatlas_stream_connection" "example-aws-lambda" { connection_name = "AWSLambdaConnection" type = "AWSLambda" aws = { - role_arn = "arn:aws:iam:::role/lambdaRole" + role_arn = "arn:aws:iam:::role/lambdaRole" } } diff --git a/examples/mongodbatlas_third_party_integration/datadog/README.md b/examples/mongodbatlas_third_party_integration/datadog/README.md index cdde93214d..fb61ec063d 100644 --- a/examples/mongodbatlas_third_party_integration/datadog/README.md +++ b/examples/mongodbatlas_third_party_integration/datadog/README.md @@ -14,16 +14,16 @@ This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -public_key = "" -private_key = "" -project_id = "" -datadog_api_key = "" +public_key = "" +private_key = "" +project_id = "" +datadog_api_key = "" ``` **2\. Review the Terraform plan.** diff --git a/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md b/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md index eff5102f69..634ff0d1fc 100644 --- a/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md +++ b/examples/mongodbatlas_third_party_integration/prometheus-and-teams/Readme.md @@ -26,8 +26,8 @@ You can refer to the MongoDB Atlas documentation to know about the parameters th This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. diff --git a/examples/starter/Readme.md b/examples/starter/Readme.md index 2b3fc60cd2..262f25d52b 100644 --- a/examples/starter/Readme.md +++ b/examples/starter/Readme.md @@ -26,8 +26,8 @@ You can refer to the MongoDB Atlas documentation to know about the region names This can be done using environment variables: ```bash -export MONGODB_ATLAS_PUBLIC_KEY="" -export MONGODB_ATLAS_PRIVATE_KEY="" +export MONGODB_ATLAS_PUBLIC_KEY="" +export MONGODB_ATLAS_PRIVATE_KEY="" ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values and make sure **not to commit it**. From 0e1011bc22d87bbb95e7c16613b954bf1b72a480 Mon Sep 17 00:00:00 2001 From: Leo Antoli <430982+lantoli@users.noreply.github.com> Date: Mon, 14 Apr 2025 12:17:37 +0200 Subject: [PATCH 6/6] -> --- docs/index.md | 4 ++-- examples/mongodbatlas_cloud_provider_access/aws/README.md | 2 +- .../aws/atlas-cluster/README.md | 2 +- .../aws/multi-region-cluster/README.MD | 2 +- .../azure/README.md | 2 +- examples/mongodbatlas_network_peering/aws/Readme.md | 2 +- .../aws/cluster-geosharded/README.md | 4 ++-- .../mongodbatlas_privatelink_endpoint/aws/cluster/README.md | 4 ++-- .../aws/data-federation-online-archive/README.md | 4 ++-- examples/mongodbatlas_push_based_log_export/README.md | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/index.md b/docs/index.md index ad655bdcba..13e39e18b6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -102,7 +102,7 @@ Note: this policy may be overly broad for many use cases, feel free to adjust ac 3. In terminal, store as environmental variables AWS API Keys (while you can also hardcode in config files these will then be stored as plain text in .tfstate file and should be avoided if possible). For example: ``` -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` 4. In terminal, use the AWS CLI command: `aws sts assume-role --role-arn ROLE_ARN_FROM_ABOVE --role-session-name newSession` @@ -111,7 +111,7 @@ Note: AWS STS secrets are short lived by default, use the ` --duration-seconds` 5. Store each of the 3 new created secrets from AWS STS as environment variables (hardcoding secrets into config file with additional risk is also supported). For example: ``` -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' export AWS_SESSION_TOKEN="" ``` diff --git a/examples/mongodbatlas_cloud_provider_access/aws/README.md b/examples/mongodbatlas_cloud_provider_access/aws/README.md index 23c68cc602..ebc8c672f0 100644 --- a/examples/mongodbatlas_cloud_provider_access/aws/README.md +++ b/examples/mongodbatlas_cloud_provider_access/aws/README.md @@ -25,7 +25,7 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` diff --git a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md index 105c40b195..7ea58f0531 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md +++ b/examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md @@ -38,7 +38,7 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` diff --git a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD index 52bb6f58e5..77d215fde6 100644 --- a/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD +++ b/examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD @@ -38,7 +38,7 @@ atlas_org_id = "63f4d4a47baeac59406dc131" **2\. Set your AWS access key & secret via environment variables: ```bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` diff --git a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md index 2f70ef1eb8..5ad6a03722 100644 --- a/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md +++ b/examples/mongodbatlas_federated_settings_identity_provider/azure/README.md @@ -151,7 +151,7 @@ Configuring the `ssh_public_key` for the Azure VM: ```shell cd ~/.ssh -ssh-keygen -t rsa -b 4096 -C "" # to generate a keypair for the VM +ssh-keygen -t rsa -b 4096 -C "" # to generate a keypair for the VM export TF_VAR_ssh_public_key=$(cat ~/.ssh/id_rsa.pub) # set the `ssh_public_key` with an env var instead of using the variable ``` diff --git a/examples/mongodbatlas_network_peering/aws/Readme.md b/examples/mongodbatlas_network_peering/aws/Readme.md index 1f775c7f3a..c727f680c2 100644 --- a/examples/mongodbatlas_network_peering/aws/Readme.md +++ b/examples/mongodbatlas_network_peering/aws/Readme.md @@ -19,7 +19,7 @@ on darwin_amd64 This can be done using environment variables: ``` bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md index e011fdf555..68d13b3c8a 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster-geosharded/README.md @@ -25,7 +25,7 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` @@ -34,7 +34,7 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = +aws_access_key_id = aws_secret_access_key = ``` diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md index 4afa05f7ee..dd1fe8f5c4 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/cluster/README.md @@ -30,13 +30,13 @@ export AWS_ACCESS_KEY_ID='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = +aws_access_key_id = aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: ``` -access_key = "" +access_key = "" secret_key = "" public_key = "" private_key = "" diff --git a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md index 50a496422f..c4e54d77fe 100644 --- a/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md +++ b/examples/mongodbatlas_privatelink_endpoint/aws/data-federation-online-archive/README.md @@ -21,7 +21,7 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` @@ -30,7 +30,7 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = +aws_access_key_id = aws_secret_access_key = ``` diff --git a/examples/mongodbatlas_push_based_log_export/README.md b/examples/mongodbatlas_push_based_log_export/README.md index d9363a33bb..c711a52aa3 100644 --- a/examples/mongodbatlas_push_based_log_export/README.md +++ b/examples/mongodbatlas_push_based_log_export/README.md @@ -26,7 +26,7 @@ export MONGODB_ATLAS_PRIVATE_KEY="" ``` ``` bash -export AWS_ACCESS_KEY_ID='' +export AWS_ACCESS_KEY_ID='' export AWS_SECRET_ACCESS_KEY='' ``` @@ -35,7 +35,7 @@ export AWS_SECRET_ACCESS_KEY='' ``` $ cat ~/.aws/credentials [default] -aws_access_key_id = +aws_access_key_id = aws_secret_access_key = ``` ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values. For example: