Skip to content

Commit 230327a

Browse files
authored
Correct cluster labels documentation (#286)
Remove incorrect labels section and added example in cluster resource doc. Clarified in datasource doc.
1 parent b301463 commit 230327a

File tree

3 files changed

+18
-4
lines changed

3 files changed

+18
-4
lines changed

website/docs/d/cluster.html.markdown

+2-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,8 @@ Physical location of the region.
136136
* `analytics_nodes` - Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.
137137

138138
### Labels
139-
Contains key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
139+
Key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
140+
Note: the key `Infrastructure Tool`, is used for internal purposes to track aggregate usage.
140141

141142
* `key` - The key that was set.
142143
* `value` - The value that represents the key.

website/docs/d/clusters.html.markdown

+3-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,9 @@ Physical location of the region.
139139
* `analytics_nodes` - Indicates the number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.
140140

141141
### Labels
142-
Contains key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
142+
Key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
143+
Note: the key `Infrastructure Tool`, is used for internal purposes to track aggregate usage.
144+
143145

144146
* `key` - The key that was set.
145147
* `value` - The value that represents the key.

website/docs/r/cluster.html.markdown

+13-2
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,6 @@ To prevent this a lifecycle customization should be used, i.e.:
242242
* Cannot be used with clusters with local NVMe SSDs
243243
* Cannot be used with Azure clusters
244244
* `encryption_at_rest_provider` - (Optional) Possible values are AWS, GCP, AZURE or NONE. Only needed if you desire to manage the keys, see [Encryption at Rest using Customer Key Management](https://docs.atlas.mongodb.com/security-aws-kms/) for complete documentation. You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project. For complete documentation on configuring Encryption at Rest, see Encryption at Rest using Customer Key Management. Requires M10 or greater. and for legacy backups, backup_enabled, to be false or omitted. **Note: Atlas encrypts all cluster storage and snapshot volumes, securing all cluster data on disk: a concept known as encryption at rest, by default**.
245-
* `labels` - (Optional) Array containing key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters. You cannot set the key `Infrastructure Tool`, it is used for internal purposes to track aggregate usage.
246245
* `mongo_db_major_version` - (Optional) Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: `3.6`, `4.0`, or `4.2`. You must set this value to `4.2` if `provider_instance_size_name` is either M2 or M5.
247246
* `num_shards` - (Optional) Selects whether the cluster is a replica set or a sharded cluster. If you use the replicationSpecs parameter, you must set num_shards.
248247
* `pit_enabled` - (Optional) - Flag that indicates if the cluster uses Continuous Cloud Backup. If set to true, provider_backup_enabled must also be set to true.
@@ -381,7 +380,19 @@ Include **desired options** within advanced_configuration:
381380
* `sample_refresh_interval_bi_connector` - (Optional) Interval in seconds at which the mongosqld process re-samples data to create its relational schema. The default value is 300. The specified value must be a positive integer. Available only for Atlas deployments in which BI Connector for Atlas is enabled.
382381

383382
### Labels
384-
Contains key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
383+
384+
```hcl
385+
labels {
386+
key = "Key 1"
387+
value = "Value 1"
388+
}
389+
labels {
390+
key = "Key 2"
391+
value = "Value 2"
392+
}
393+
```
394+
395+
Key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters. You cannot set the key `Infrastructure Tool`, it is used for internal purposes to track aggregate usage.
385396

386397
* `key` - The key that you want to write.
387398
* `value` - The value that you want to write.

0 commit comments

Comments
 (0)