Skip to content

Commit 9b89111

Browse files
authored
doc: Fix use of variables in documentation (#3382)
* API_KEY_ID and ORG_ID * 0.8.0 guide * EAR example
1 parent f779a7a commit 9b89111

File tree

8 files changed

+23
-23
lines changed

8 files changed

+23
-23
lines changed

docs/data-sources/access_list_api_key.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ When you remove an entry from the access list, existing connections from the rem
1515
### Using CIDR Block
1616
```terraform
1717
resource "mongodbatlas_access_list_api_key" "test" {
18-
org_id = "<ORG-ID>"
18+
org_id = "<ORG_ID>"
1919
cidr_block = "1.2.3.4/32"
2020
api_key = "a29120e123cd"
2121
}
@@ -30,7 +30,7 @@ data "mongodbatlas_access_list_api_key" "test" {
3030
### Using IP Address
3131
```terraform
3232
resource "mongodbatlas_access_list_api_key" "test" {
33-
org_id = "<ORG-ID>"
33+
org_id = "<ORG_ID>"
3434
ip_address = "2.3.4.5"
3535
api_key = "a29120e123cd"
3636
}

docs/data-sources/access_list_api_keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When you remove an entry from the access list, existing connections from the rem
1414
### Using CIDR Block
1515
```terraform
1616
resource "mongodbatlas_access_list_api_key" "test" {
17-
org_id = "<ORG-ID>"
17+
org_id = "<ORG_ID>"
1818
cidr_block = "1.2.3.4/32"
1919
api_key = "a29120e123cd"
2020
}
@@ -29,7 +29,7 @@ data "mongodbatlas_access_list_api_key" "test" {
2929
### Using IP Address
3030
```terraform
3131
resource "mongodbatlas_access_list_api_key" "test" {
32-
org_id = "<ORG-ID>"
32+
org_id = "<ORG_ID>"
3333
ip_address = "2.3.4.5"
3434
api_key = "a29120e123cd"
3535
}

docs/data-sources/org_invitation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
```terraform
88
resource "mongodbatlas_org_invitation" "test" {
99
username = "test-acc-username"
10-
org_id = "<ORG-ID>"
10+
org_id = "<ORG_ID>"
1111
roles = [ "GROUP_DATA_ACCESS_READ_WRITE" ]
1212
}
1313

docs/guides/0.8.0-upgrade-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ Existing:
9595
```hcl
9696
aws_kms = {
9797
enabled = true
98-
access_key_id = "AKIAIOSFUDNN9EXAMPLE"
99-
secret_access_key = "wJalrXUtnFRTI/K7MDENG/bPxRfiCYEXAMPLEKEY"
100-
customer_master_key_id = "030gce02-586d-48d2-a999-05ea954fdd0g"
98+
access_key_id = "<ACCESS_KEY_ID>"
99+
secret_access_key = "<SECRET_ACCESS_KEY>"
100+
customer_master_key_id = "<CUSTOMER_MASTER_KEY_ID>"
101101
region = "US_EAST_1"
102102
}
103103
```
@@ -107,8 +107,8 @@ New:
107107
```hcl
108108
aws_kms = {
109109
enabled = true
110-
role_id = "5f232b94af0a6b41747akx2d"
111-
customer_master_key_id = "030gce02-586d-48d2-a999-05ea954fdd0g"
110+
role_id = "<ROLE_ID>"
111+
customer_master_key_id = "<CUSTOMER_MASTER_KEY_ID>"
112112
region = "US_EAST_1"
113113
}
114114
```

docs/resources/access_list_api_key.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ When you remove an entry from the access list, existing connections from the rem
1717
### Using CIDR Block
1818
```terraform
1919
resource "mongodbatlas_access_list_api_key" "test" {
20-
org_id = "<ORG-ID>"
20+
org_id = "<ORG_ID>"
2121
cidr_block = "1.2.3.4/32"
22-
api_key_id = "a29120e123cd"
22+
api_key_id = "<API_KEY_ID>"
2323
}
2424
```
2525

2626
### Using IP Address
2727
```terraform
2828
resource "mongodbatlas_access_list_api_key" "test" {
29-
org_id = "<ORG-ID>"
29+
org_id = "<ORG_ID>"
3030
ip_address = "2.3.4.5"
31-
api_key_id = "a29120e123cd"
31+
api_key_id = "<API_KEY_ID>"
3232
}
3333
```
3434

docs/resources/org_invitation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,23 @@ The [MongoDB Documentation](https://www.mongodb.com/docs/atlas/reference/user-ro
1616
```terraform
1717
resource "mongodbatlas_org_invitation" "test0" {
1818
username = "test0-acc-username"
19-
org_id = "<ORG-ID>"
19+
org_id = "<ORG_ID>"
2020
roles = [ "ORG_OWNER" ]
2121
}
2222
```
2323

2424
```terraform
2525
resource "mongodbatlas_org_invitation" "test0" {
2626
username = "test0-acc-username"
27-
org_id = "<ORG-ID>"
27+
org_id = "<ORG_ID>"
2828
roles = [ "ORG_MEMBER", "ORG_BILLING_ADMIN" ]
2929
}
3030
```
3131

3232
```terraform
3333
resource "mongodbatlas_org_invitation" "test1" {
3434
username = "test1-acc-username"
35-
org_id = "<ORG-ID>"
35+
org_id = "<ORG_ID>"
3636
teams_ids = [ "<TEAM-0-ID>", "<TEAM-1-ID>" ]
3737
roles = [ "ORG_MEMBER" ]
3838
}

examples/mongodbatlas_encryption_at_rest/aws/atlas-cluster/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
2727

2828
... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex:
2929
```hcl
30-
public_key = "examplepksy"
31-
private_key = "22b722a9-34f4-3b1b-aada-298329a5c128"
32-
atlas_org_id = "63f4d4a47baeac59406dc131"
30+
public_key = "<PUBLIC_KEY>"
31+
private_key = "<PRIVATE_KEY>"
32+
atlas_org_id = "<ATLAS_ORG_ID>"
3333
```
3434

3535
... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager)

examples/mongodbatlas_encryption_at_rest/aws/multi-region-cluster/README.MD

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ export MONGODB_ATLAS_PRIVATE_KEY="<ATLAS_PRIVATE_KEY>"
2727

2828
... or follow as in the `variables.tf` file and create **terraform.tfvars** file with all the variable values, ex:
2929
```hcl
30-
public_key = "examplepksy"
31-
private_key = "22b722a9-34f4-3b1b-aada-298329a5c128"
32-
atlas_org_id = "63f4d4a47baeac59406dc131"
30+
public_key = "<PUBLIC_KEY>"
31+
private_key = "<PRIVATE_KEY>"
32+
atlas_org_id = "<ATLAS_ORG_ID>"
3333
```
3434

3535
... or use [AWS Secrets Manager](https://github.com/mongodb/terraform-provider-mongodbatlas/blob/master/docs/index.md#aws-secrets-manager)

0 commit comments

Comments
 (0)