Skip to content

Commit d6797db

Browse files
authored
Roll up for documentation fixes (#576)
Fixes for issues #555, #568, and updating that the free tier, M0, can now be created via API.
1 parent 25f3666 commit d6797db

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

website/docs/r/auditing.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ resource "mongodbatlas_auditing" "test" {
2424
## Argument Reference
2525

2626
* `project_id` - (Required) The unique ID for the project to configure auditing.
27-
* `audit_filter` - Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. For more information, see auditAuthorizationSuccess
28-
* `audit_authorization_success` - JSON-formatted audit filter used by the project
29-
* `enabled` - Denotes whether or not the project associated with the {project_id} has database auditing enabled.
27+
* `audit_authorization_success` - Indicates whether the auditing system captures successful authentication attempts for audit filters using the "atype" : "authCheck" auditing event. For more information, see [auditAuthorizationSuccess](https://docs.mongodb.com/manual/reference/parameters/#param.auditAuthorizationSuccess). **Warning! Enabling Audit authorization successes can severely impact cluster performance. Enable this option with caution.**
28+
* `audit_filter` - JSON-formatted audit filter. For complete documentation on custom auditing filters, see [Configure Audit Filters](https://docs.mongodb.com/manual/tutorial/configure-audit-filters/).
29+
* `enabled` - Denotes whether or not the project associated with the {project_id} has database auditing enabled. Defaults to false.
3030

3131
~> **NOTE:** Auditing created by API Keys must belong to an existing organization.
3232

website/docs/r/cluster.html.markdown

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ description: |-
1515
-> **NOTE:** A network container is created for a cluster to reside in if one does not yet exist in the project. To use this automatically created container with another resource, such as peering, the `container_id` is exported after creation.
1616

1717
~> **IMPORTANT:**
18-
<br> &#8226; Free tier cluster creation (M0) is not supported via API or by this Provider.
19-
<br> &#8226; Shared tier clusters (M2, M5) cannot be upgraded to higher tiers via API or by this Provider. WARNING! If you attempt to upgrade from an existing shared tier cluster that you manage with this Provider to a dedicated cluster (M10+) Terraform will see it as a request to destroy the shared tier cluster and as a request to create a dedicated tier cluster, i.e. Terraform will not see it as a request to upgrade. If you accept the plan in this case the shared tier cluster would be destroyed and you would lose the data on that cluster. Do not attempt to upgrade from the shared to dedicated tier via this Provider, it is not supported!
18+
<br> &#8226; Free tier cluster creation (M0) is supported.
19+
<br> &#8226; Shared tier clusters (M0, M2, M5) cannot be upgraded to higher tiers via API or by this Provider. WARNING! If you attempt to upgrade from an existing shared tier cluster that you manage with this Provider to a dedicated cluster (M10+) Terraform will see it as a request to destroy the shared tier cluster and as a request to create a dedicated tier cluster, i.e. Terraform will not see it as a request to upgrade. If you accept the plan in this case the shared tier cluster would be destroyed and you would lose the data on that cluster. Do not attempt to upgrade from the shared to dedicated tier via this Provider, it is not supported!
2020
<br> &#8226; Changes to cluster configurations can affect costs. Before making changes, please see [Billing](https://docs.atlas.mongodb.com/billing/).
2121
<br> &#8226; If your Atlas project contains a custom role that uses actions introduced in a specific MongoDB version, you cannot create a cluster with a MongoDB version less than that version unless you delete the custom role.
2222

@@ -42,7 +42,7 @@ resource "mongodbatlas_cluster" "cluster-test" {
4242
auto_scaling_disk_gb_enabled = true
4343
mongo_db_major_version = "4.2"
4444
45-
//Provider Settings "block"
45+
# Provider Settings "block"
4646
provider_name = "AWS"
4747
disk_size_gb = 100
4848
provider_instance_size_name = "M40"
@@ -59,7 +59,7 @@ resource "mongodbatlas_cluster" "test" {
5959
replication_specs {
6060
num_shards = 1
6161
regions_config {
62-
region_name = "US_EAST_1"
62+
region_name = "US_EAST"
6363
electable_nodes = 3
6464
priority = 7
6565
read_only_nodes = 0
@@ -69,7 +69,7 @@ resource "mongodbatlas_cluster" "test" {
6969
auto_scaling_disk_gb_enabled = true
7070
mongo_db_major_version = "4.2"
7171
72-
//Provider Settings "block"
72+
# Provider Settings "block"
7373
provider_name = "AZURE"
7474
provider_disk_type_name = "P6"
7575
provider_instance_size_name = "M30"
@@ -86,7 +86,7 @@ resource "mongodbatlas_cluster" "test" {
8686
replication_specs {
8787
num_shards = 1
8888
regions_config {
89-
region_name = "US_EAST_1"
89+
region_name = "EASTERN_US"
9090
electable_nodes = 3
9191
priority = 7
9292
read_only_nodes = 0
@@ -96,7 +96,7 @@ resource "mongodbatlas_cluster" "test" {
9696
auto_scaling_disk_gb_enabled = true
9797
mongo_db_major_version = "4.2"
9898
99-
//Provider Settings "block"
99+
# Provider Settings "block"
100100
provider_name = "GCP"
101101
disk_size_gb = 40
102102
provider_instance_size_name = "M30"
@@ -114,7 +114,7 @@ resource "mongodbatlas_cluster" "cluster-test" {
114114
cloud_backup = true
115115
cluster_type = "REPLICASET"
116116
117-
//Provider Settings "block"
117+
# Provider Settings "block"
118118
provider_name = "AWS"
119119
provider_instance_size_name = "M10"
120120
@@ -153,7 +153,7 @@ resource "mongodbatlas_cluster" "cluster-test" {
153153
cloud_backup = true
154154
cluster_type = "GEOSHARDED"
155155
156-
//Provider Settings "block"
156+
# Provider Settings "block"
157157
provider_name = "AWS"
158158
provider_instance_size_name = "M30"
159159
@@ -180,23 +180,30 @@ resource "mongodbatlas_cluster" "cluster-test" {
180180
}
181181
}
182182
```
183-
### Example AWS Shared Tier cluster
183+
### Example AWS Shared Tier (M2/M5) cluster
184184
```hcl
185185
resource "mongodbatlas_cluster" "cluster-test" {
186186
project_id = "<YOUR-PROJECT-ID>"
187187
name = "cluster-test-global"
188-
//M2 must be 2, M5 must be 5
189-
disk_size_gb = "2"
190188
191-
//Provider Settings "block"
189+
# Provider Settings "block"
192190
provider_name = "TENANT"
193191
backing_provider_name = "AWS"
194192
provider_region_name = "US_EAST_1"
195193
provider_instance_size_name = "M2"
194+
}
195+
```
196+
### Example AWS Free Tier cluster
197+
```hcl
198+
resource "mongodbatlas_cluster" "cluster-test" {
199+
project_id = "<YOUR-PROJECT-ID>"
200+
name = "cluster-test-global"
196201
197-
//These must be the following values
198-
mongo_db_major_version = "4.2"
199-
auto_scaling_disk_gb_enabled = "false"
202+
# Provider Settings "block"
203+
provider_name = "TENANT"
204+
backing_provider_name = "AWS"
205+
provider_region_name = "US_EAST_1"
206+
provider_instance_size_name = "M0"
200207
}
201208
```
202209
### Example - Return a Connection String
@@ -205,43 +212,43 @@ AWS Private Endpoint
205212
output "plstring" {
206213
value = lookup(mongodbatlas_cluster.cluster-test.connection_strings[0].private_endpoint[0].srv_connection_string, aws_vpc_endpoint.ptfe_service.id)
207214
}
208-
//Example return string: plstring = mongodb+srv://cluster-atlas-pl-0.za3fb.mongodb.net
215+
# Example return string: plstring = mongodb+srv://cluster-atlas-pl-0.za3fb.mongodb.net
209216
```
210217
Azure Private Endpoint
211218
```hcl
212219
output "plstring" {
213220
value = lookup(mongodbatlas_cluster.cluster-test.connection_strings[0].private_endpoint[0].srv_connection_string, azurerm_private_endpoint.test.id)
214221
}
215-
//Example return string: plstring = mongodb+srv://cluster-atlas-pl-0.za3fb.mongodb.net
222+
# Example return string: plstring = mongodb+srv://cluster-atlas-pl-0.za3fb.mongodb.net
216223
```
217224
Standard
218225
```hcl
219226
output "standard" {
220227
value = mongodbatlas_cluster.cluster-test.connection_strings[0].standard
221228
}
222-
//Example return string: standard = "mongodb://cluster-atlas-shard-00-00.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-01.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-02.ygo1m.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-12diht-shard-0"
229+
# Example return string: standard = "mongodb://cluster-atlas-shard-00-00.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-01.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-02.ygo1m.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-12diht-shard-0"
223230
```
224231
Standard srv
225232
```hcl
226233
output "standard_srv" {
227234
value = mongodbatlas_cluster.cluster-test.connection_strings[0].standard_srv
228235
}
229-
//Example return string: standard_srv = "mongodb+srv://cluster-atlas.ygo1m.mongodb.net"
236+
# Example return string: standard_srv = "mongodb+srv://cluster-atlas.ygo1m.mongodb.net"
230237
```
231238
Private with Network peering and Custom DNS AWS enabled
232239
```hcl
233240
output "private" {
234241
value = mongodbatlas_cluster.cluster-test.connection_strings[0].private
235242
}
236-
//Example return string: private = "mongodb://cluster-atlas-shard-00-00-pri.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-01-pri.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-02-pri.ygo1m.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-12diht-shard-0"
243+
# Example return string: private = "mongodb://cluster-atlas-shard-00-00-pri.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-01-pri.ygo1m.mongodb.net:27017,cluster-atlas-shard-00-02-pri.ygo1m.mongodb.net:27017/?ssl=true&authSource=admin&replicaSet=atlas-12diht-shard-0"
237244
private = "mongodb+srv://cluster-atlas-pri.ygo1m.mongodb.net"
238245
```
239246
Private srv with Network peering and Custom DNS AWS enabled
240247
```hcl
241248
output "private_srv" {
242249
value = mongodbatlas_cluster.cluster-test.connection_strings[0].private_srv
243250
}
244-
//Example return string: private_srv = "mongodb+srv://cluster-atlas-pri.ygo1m.mongodb.net"
251+
# Example return string: private_srv = "mongodb+srv://cluster-atlas-pri.ygo1m.mongodb.net"
245252
```
246253

247254
## Argument Reference
@@ -257,7 +264,6 @@ output "private_srv" {
257264
- `TENANT` - A multi-tenant deployment on one of the supported cloud service providers. Only valid when providerSettings.instanceSizeName is either M2 or M5.
258265
* `name` - (Required) Name of the cluster as it appears in Atlas. Once the cluster is created, its name cannot be changed.
259266
* `provider_instance_size_name` - (Required) Atlas provides different instance sizes, each with a default storage capacity and RAM size. The instance size you select is used for all the data-bearing servers in your cluster. See [Create a Cluster](https://docs.atlas.mongodb.com/reference/api/clusters-create-one/) `providerSettings.instanceSizeName` for valid values and default resources.
260-
**Note** free tier (M0) creation is not supported by the Atlas API and hence not supported by this provider.)
261267

262268
* `auto_scaling_disk_gb_enabled` - (Optional) Specifies whether disk auto-scaling is enabled. The default is true.
263269
- Set to `true` to enable disk auto-scaling.

0 commit comments

Comments
 (0)