You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
INTMDB-293: Added container_id in advanced cluster (#663)
* feat: added parameter container ids for advanced cluster
* fixes linter
* refactor: changed the name region_configs_containers_ids to container_id
* refactor suggested by tony
* changed emails for teams
* fixes test
Copy file name to clipboardExpand all lines: website/docs/d/advanced_cluster.html.markdown
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -85,6 +85,7 @@ Key-value pairs that tag and categorize the cluster. Each key and value has a ma
85
85
86
86
*`num_shards` - Provide this value if you set a `cluster_type` of SHARDED or GEOSHARDED.
87
87
*`region_configs` - Configuration for the hardware specifications for nodes set for a given regionEach `region_configs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `region_configs` object must have either an `analytics_specs` object, `electable_specs` object, or `read_only_specs` object. See [below](#region_configs)
88
+
*`container_id` - A key-value map of the Network Peering Container ID(s) for the configuration specified in `region_configs`. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is `"providerName:regionName" = "containerId"`. Example `AWS:US_EAST_1" = "61e0797dde08fb498ca11a71`.
88
89
*`zone_name` - Name for the zone in a Global Cluster.
Copy file name to clipboardExpand all lines: website/docs/d/advanced_clusters.html.markdown
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,6 +87,7 @@ Key-value pairs that tag and categorize the cluster. Each key and value has a ma
87
87
88
88
*`num_shards` - Provide this value if you set a `cluster_type` of SHARDED or GEOSHARDED.
89
89
*`region_configs` - Configuration for the hardware specifications for nodes set for a given regionEach `region_configs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `region_configs` object must have either an `analytics_specs` object, `electable_specs` object, or `read_only_specs` object. See [below](#region_configs)
90
+
*`container_id` - A key-value map of the Network Peering Container ID(s) for the configuration specified in `region_configs`. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is `"providerName:regionName" = "containerId"`. Example `AWS:US_EAST_1" = "61e0797dde08fb498ca11a71`.
90
91
*`zone_name` - Name for the zone in a Global Cluster.
Copy file name to clipboardExpand all lines: website/docs/r/advanced_cluster.html.markdown
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,8 @@ More information on considerations for using advanced clusters please see [Consi
14
14
15
15
-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.
16
16
17
+
-> **NOTE:** A network container is created for a advanced 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.
18
+
17
19
## Example Usage
18
20
19
21
@@ -246,6 +248,7 @@ replication_specs {
246
248
247
249
*`num_shards` - (Required) Provide this value if you set a `cluster_type` of SHARDED or GEOSHARDED. Omit this value if you selected a `cluster_type` of REPLICASET. This API resource accepts 1 through 50, inclusive. This parameter defaults to 1. If you specify a `num_shards` value of 1 and a `cluster_type` of SHARDED, Atlas deploys a single-shard [sharded cluster](https://docs.atlas.mongodb.com/reference/glossary/#std-term-sharded-cluster). Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.
248
250
*`region_configs` - (Optional) Configuration for the hardware specifications for nodes set for a given regionEach `region_configs` object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region. Each `region_configs` object must have either an `analytics_specs` object, `electable_specs` object, or `read_only_specs` object. See [below](#region_configs)
251
+
*`container_id` - A key-value map of the Network Peering Container ID(s) for the configuration specified in `region_configs`. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. The syntax is `"providerName:regionName" = "containerId"`. Example `AWS:US_EAST_1" = "61e0797dde08fb498ca11a71`.
249
252
*`zone_name` - (Optional) Name for the zone in a Global Cluster.
0 commit comments