doc: Unify credential variables in docs and examples (#3277)

* redacted

* use YOUR... for credential variables

* more changes

* account id

* remove YOUR_

* <AWS_KEY_ID> -> <AWS_ACCESS_KEY_ID>

Author: lantoli

contributing/development-setup.md

@@ -130,117 +130,116 @@ 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=<YOUR_PROJECT_ID>
-  export MONGODB_ATLAS_ORG_ID=<YOUR_ORG_ID>
-  export MONGODB_ATLAS_PUBLIC_KEY=<YOUR_PUBLIC_KEY>
-  export MONGODB_ATLAS_PRIVATE_KEY=<YOUR_PRIVATE_KEY>
+  export MONGODB_ATLAS_PUBLIC_KEY=<ATLAS_PUBLIC_KEY>
+  export MONGODB_ATLAS_PRIVATE_KEY=<ATLAS_PRIVATE_KEY>
+  export MONGODB_ATLAS_ORG_ID=<ATLAS_ORG_ID>
+  export MONGODB_ATLAS_PROJECT_ID=<ATLAS_PROJECT_ID>
 
   # This env variable is optional and allow you to run terraform with a custom server
   export MONGODB_ATLAS_BASE_URL=<CUSTOM_SERVER_URL>
   ```
 
 - For `Authentication database user` resource configuration:
   ```bash
-  $ export MONGODB_ATLAS_DB_USERNAME=<YOUR_DATABASE_NAME>
+  export MONGODB_ATLAS_DB_USERNAME=<ATLAS_DATABASE_NAME>
   ```
 
 - For `Project(s)` resource configuration:
   ```bash
-  $ export MONGODB_ATLAS_TEAMS_IDS=<YOUR_TEAMS_IDS>
+  export MONGODB_ATLAS_TEAMS_IDS=<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=<YOUR_FEDERATION_SETTINGS_ID>
-  $ export ONGODB_ATLAS_FEDERATED_ORG_ID=<YOUR_FEDERATED_ORG_ID>
-  $ export MONGODB_ATLAS_FEDERATED_GROUP_ID=<YOUR_FEDERATED_GROUP_ID>
-  $ export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID=<YOUR_FEDERATED_ROLE_MAPPING_ID>
-  $ export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID=<YOUR_FEDERATED_OKTA_IDP_ID>
-  $ export MONGODB_ATLAS_FEDERATED_SSO_URL=<YOUR_FEDERATED_SSO_URL>
-  $ export MONGODB_ATLAS_FEDERATED_ISSUER_URI=<YOUR_FEDERATED_ISSUER_URI>
+  export MONGODB_ATLAS_FEDERATION_SETTINGS_ID=<ATLAS_FEDERATION_SETTINGS_ID>
+  export MONGODB_ATLAS_FEDERATED_ORG_ID=<ATLAS_FEDERATED_ORG_ID>
+  export MONGODB_ATLAS_FEDERATED_GROUP_ID=<ATLAS_FEDERATED_GROUP_ID>
+  export MONGODB_ATLAS_FEDERATED_ROLE_MAPPING_ID=<ATLAS_FEDERATED_ROLE_MAPPING_ID>
+  export MONGODB_ATLAS_FEDERATED_OKTA_IDP_ID=<ATLAS_FEDERATED_OKTA_IDP_ID>
+  export MONGODB_ATLAS_FEDERATED_SSO_URL=<ATLAS_FEDERATED_SSO_URL>
+  export MONGODB_ATLAS_FEDERATED_ISSUER_URI=<ATLAS_FEDERATED_ISSUER_URI>
   ```
 ~> **Notice:** For more information about the Federation configuration resource, see: https://www.mongodb.com/docs/atlas/reference/api/federation-configuration/
 
 ##### AWS env variables
 
 - For `Network Peering` resource configuration:
   ```bash
-  $ export AWS_ACCOUNT_ID=<YOUR_ACCOUNT_ID>
-  $ export AWS_VPC_ID=<YOUR_VPC_ID>
-  $ export AWS_VPC_CIDR_BLOCK=<YOUR_VPC_CIDR_BLOCK>
-  $ export AWS_REGION=<YOUR_REGION>
-  $ export AWS_SUBNET_ID=<YOUR_SUBNET_ID>
-  $ export AWS_SECURITY_GROUP_ID=<YOUR_SECURITY_GROUP_ID>
+  export AWS_ACCOUNT_ID=<AWS_ACCOUNT_ID>
+  export AWS_VPC_ID=<AWS_VPC_ID>
+  export AWS_VPC_CIDR_BLOCK=<AWS_VPC_CIDR_BLOCK>
+  export AWS_REGION=<AWS_REGION>
+  export AWS_SUBNET_ID=<AWS_SUBNET_ID>
+  export AWS_SECURITY_GROUP_ID=<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=<YOUR_ACCESS_KEY_ID>
-  $ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
-  $ export AWS_CUSTOMER_MASTER_KEY_ID=<YOUR_CUSTOMER_MASTER_KEY_ID>
-  $ export AWS_REGION=<YOUR_REGION>
-
-  $ export AWS_ACCESS_KEY_ID_UPDATED=<YOUR_ACCESS_KEY_ID_UPDATED>
-  $ export AWS_SECRET_ACCESS_KEY_UPDATED=<YOUR_SECRET_ACCESS_KEY_UPDATED>
-  $ export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED=<YOUR_CUSTOMER_MASTER_KEY_ID_UPDATED>
-  $ export AWS_REGION_UPDATED=<YOUR_REGION_UPDATED>
+  export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
+  export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
+  export AWS_CUSTOMER_MASTER_KEY_ID=<AWS_CUSTOMER_MASTER_KEY_ID>
+  export AWS_REGION=<AWS_REGION>
+
+  export AWS_ACCESS_KEY_ID_UPDATED=<AWS_ACCESS_KEY_ID_UPDATED>
+  export AWS_SECRET_ACCESS_KEY_UPDATED=<AWS_SECRET_ACCESS_KEY_UPDATED>
+  export AWS_CUSTOMER_MASTER_KEY_ID_UPDATED=<AWS_CUSTOMER_MASTER_KEY_ID_UPDATED>
+  export AWS_REGION_UPDATED=<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=<YOUR_ACCESS_KEY_ID>
-  $ export AWS_SECRET_ACCESS_KEY=<YOUR_SECRET_ACCESS_KEY>
-  $ export AWS_CUSTOMER_MASTER_KEY_ID=<YOUR_CUSTOMER_MASTER_KEY_ID>
-  $ export AWS_REGION=<YOUR_REGION>
-  $ export AWS_VPC_ID=<YOUR_VPC_ID>
-  $ export AWS_SUBNET_ID=<YOUR_SUBNET_ID>
-  $ export AWS_SECURITY_GROUP_ID=<YOUR_SECURITY_GROUP_ID>
+  export AWS_ACCESS_KEY_ID=<AWS_ACCESS_KEY_ID>
+  export AWS_SECRET_ACCESS_KEY=<AWS_SECRET_ACCESS_KEY>
+  export AWS_CUSTOMER_MASTER_KEY_ID=<AWS_CUSTOMER_MASTER_KEY_ID>
+  export AWS_REGION=<AWS_REGION>
+  export AWS_VPC_ID=<AWS_VPC_ID>
+  export AWS_SUBNET_ID=<AWS_SUBNET_ID>
+  export AWS_SECURITY_GROUP_ID=<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/
 
 ##### AZURE env variables
 
 - For `Network Peering` resource configuration:
   ```bash
-  $ export AZURE_DIRECTORY_ID=<YOUR_DIRECTORY_ID>
-  $ export AZURE_SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION_ID>
-  $ export AZURE_RESOURCE_GROUP_NAME=<YOUR_RESOURCE_GROUP_NAME>
-  $ export AZURE_VNET_NAME=<YOUR_VNET_NAME>
+  export AZURE_DIRECTORY_ID=<AZURE_DIRECTORY_ID>
+  export AZURE_SUBSCRIPTION_ID=<AZURE_SUBSCRIPTION_ID>
+  export AZURE_RESOURCE_GROUP_NAME=<AZURE_RESOURCE_GROUP_NAME>
+  export AZURE_VNET_NAME=<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=<YOUR_CLIENT_ID>
-  export AZURE_SUBSCRIPTION_ID=<YOUR_SUBSCRIPTION_ID>
-  export AZURE_RESOURCE_GROUP_NAME=<YOUR_RESOURCE_GROUP_NAME>
-  export AZURE_APP_SECRET=<YOUR_SECRET>
-  export AZURE_KEY_VAULT_NAME=<YOUR_KEY_VAULT_NAME>
-  export AZURE_KEY_IDENTIFIER=<YOUR_KEY_IDENTIFIER>
-  export AZURE_TENANT_ID=<YOUR_TENANT_ID>
-  export AZURE_DIRECTORY_ID=<YOUR_DIRECTORY_ID>
-
-  export AZURE_KEY_VAULT_NAME_UPDATED=<YOUR_KEY_VAULT_NAME_UPDATED>
-  export AZURE_KEY_IDENTIFIER_UPDATED=<YOUR_KEY_IDENTIFIER_UPDATED>
+  export AZURE_CLIENT_ID=<AZURE_CLIENT_ID>
+  export AZURE_SUBSCRIPTION_ID=<AZURE_SUBSCRIPTION_ID>
+  export AZURE_RESOURCE_GROUP_NAME=<AZURE_RESOURCE_GROUP_NAME>
+  export AZURE_APP_SECRET=<AZURE_APP_SECRET>
+  export AZURE_KEY_VAULT_NAME=<AZURE_KEY_VAULT_NAME>
+  export AZURE_KEY_IDENTIFIER=<AZURE_KEY_IDENTIFIER>
+  export AZURE_TENANT_ID=<AZURE_TENANT_ID>
+  export AZURE_DIRECTORY_ID=<AZURE_DIRECTORY_ID>
+  export AZURE_KEY_VAULT_NAME_UPDATED=<AZURE_KEY_VAULT_NAME_UPDATED>
+  export AZURE_KEY_IDENTIFIER_UPDATED=<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=<YOUR_PROJECT_ID>
+  $export GCP_PROJECT_ID=<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=<YOUR_GCP_SERVICE_ACCOUNT_KEY>
-  $ export GCP_KEY_VERSION_RESOURCE_ID=<YOUR_GCP_KEY_VERSION_RESOURCE_ID>
+  export GCP_SERVICE_ACCOUNT_KEY=<GCP_SERVICE_ACCOUNT_KEY>
+  export GCP_KEY_VERSION_RESOURCE_ID=<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/
 

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::<AWS_ACCOUNT_ID>: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.
+* [Contact Support](https://docs.atlas.mongodb.com/support/) covered by MongoDB Atlas support plans, Developer and above.

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="xxxx"
-$  export MONGODB_ATLAS_PRIVATE_KEY="xxxx"
+$  export MONGODB_ATLAS_PUBLIC_KEY="<ATLAS_PUBLIC_KEY>"
+$  export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
 $ terraform plan
 ```
 
@@ -102,34 +102,34 @@ 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='<AWS_ACCESS_KEY_ID>'
+export AWS_SECRET_ACCESS_KEY='<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` 
 
 Note: AWS STS secrets are short lived by default, use the ` --duration-seconds` flag to specify longer duration as needed 
 
 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='<AWS_ACCESS_KEY_ID>'
+export AWS_SECRET_ACCESS_KEY='<AWS_SECRET_ACCESS_KEY>'
+export AWS_SESSION_TOKEN="<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:
 ```terraform
 # 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::<AWS_ACCOUNT_ID>: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:<AWS_ACCOUNT_ID>: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_ACCESS_KEY_ID>"
+  aws_secret_access_key = "<AWS_SECRET_ACCESS_KEY>"
+  aws_session_token     = "<AWS_SESSION_TOKEN>"
   sts_endpoint          = "https://sts.us-east-2.amazonaws.com/"
 }
 ```

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::<AWS_ACCOUNT_ID>:role/test-user-role"
    }
 }
 

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::<AWS_ACCOUNT_ID>:role/lambdaRole"
     }
 }
 

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="<ATLAS_PUBLIC_KEY>"
+export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
 ```
 
 ## Step 1: Create the `mongodbatlas_cluster` with `v1` of the module

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="<ATLAS_PUBLIC_KEY>"
+export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
 ```
 
 ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex:

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="<ATLAS_PUBLIC_KEY>"
+export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
 ```
 
 ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex:

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                = <YOUR_ORG_ID>
-public_key                  = <REDACTED>
-private_key                 = <REDACTED>
+atlas_org_id                = <ATLAS_ORG_ID>
+public_key                  = <ATLAS_PUBLIC_KEY>
+private_key                 = <ATLAS_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                = <YOUR_ORG_ID>
-public_key                  = <REDACTED>
-private_key                 = <REDACTED>
+atlas_org_id                = <ATLAS_ORG_ID>
+public_key                  = <ATLAS_PUBLIC_KEY>
+private_key                 = <ATLAS_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                = <YOUR_ORG_ID>
-public_key                  = <REDACTED>
-private_key                 = <REDACTED>
+atlas_org_id                = <ATLAS_ORG_ID>
+public_key                  = <ATLAS_PUBLIC_KEY>
+private_key                 = <ATLAS_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"
   }
 }
-```
+```

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="<ATLAS_PUBLIC_KEY>"
+export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
 ```
 
 ... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex: