Skip to content

Commit 40b4917

Browse files
fix: update cluster labels doc to make it clear that labels are not resource tag (#1425)
1 parent 0889930 commit 40b4917

File tree

6 files changed

+27
-12
lines changed

6 files changed

+27
-12
lines changed

website/docs/d/advanced_cluster.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,14 @@ Specifies BI Connector for Atlas configuration.
7676

7777
### labels
7878

79-
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.
79+
Key-value pairs that 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.
8080

8181
* `key` - The key that you want to write.
8282
* `value` - The value that you want to write.
8383

84+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
85+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
86+
8487

8588
### replication_specs
8689

website/docs/d/advanced_clusters.html.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,15 @@ Specifies BI Connector for Atlas configuration.
7878

7979
### labels
8080

81-
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.
81+
82+
Key-value pairs that 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.
8283

8384
* `key` - The key that you want to write.
8485
* `value` - The value that you want to write.
8586

87+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
88+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
89+
8690

8791
### replication_specs
8892

website/docs/d/cluster.html.markdown

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -166,11 +166,13 @@ Physical location of the region.
166166
* `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.
167167

168168
### Labels
169-
Key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
170-
Note: the key `Infrastructure Tool`, is used for internal purposes to track aggregate usage.
169+
Key-value pairs that 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.
171170

172-
* `key` - The key that was set.
173-
* `value` - The value that represents the key.
171+
* `key` - The key that you want to write.
172+
* `value` - The value that you want to write.
173+
174+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
175+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
174176

175177
### Plugin
176178
Contains a key-value pair that tags that the cluster was created by a Terraform Provider and notes the version.

website/docs/d/clusters.html.markdown

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,13 @@ Physical location of the region.
156156
* `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.
157157

158158
### Labels
159-
Key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.
160-
Note: the key `Infrastructure Tool`, is used for internal purposes to track aggregate usage.
159+
Key-value pairs that 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.
161160

161+
* `key` - The key that you want to write.
162+
* `value` - The value that you want to write.
162163

163-
* `key` - The key that was set.
164-
* `value` - The value that represents the key.
164+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
165+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
165166

166167

167168
### Plugin

website/docs/r/advanced_cluster.html.markdown

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,11 +475,14 @@ Include **desired options** within advanced_configuration:
475475
}
476476
```
477477

478-
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.
478+
Key-value pairs that 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.
479479

480480
* `key` - The key that you want to write.
481481
* `value` - The value that you want to write.
482482

483+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
484+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
485+
483486

484487
### replication_specs
485488

website/docs/r/cluster.html.markdown

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,11 +511,13 @@ Include **desired options** within advanced_configuration:
511511
}
512512
```
513513

514-
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.
514+
Key-value pairs that 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.
515515

516516
* `key` - The key that you want to write.
517517
* `value` - The value that you want to write.
518518

519+
-> **NOTE:** MongoDB Atlas doesn't display your labels.
520+
-> **NOTE:** Cluster labels are not the same as [resource TAGs](https://www.mongodb.com/docs/atlas/tags/). We plan to add [resource TAGs](https://www.mongodb.com/docs/atlas/tags/) support in a future release.
519521

520522
## Attributes Reference
521523

0 commit comments

Comments
 (0)