Skip to content

Commit a9f4887

Browse files
authored
doc: Fixes wordings in the new advanced_cluster sharding guide. (#2524)
1 parent cba054c commit a9f4887

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

docs/data-sources/advanced_cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ data "mongodbatlas_advanced_cluster" "example" {
3535
}
3636
```
3737

38-
## Example using latest sharding schema with independent shard scaling in the cluster
38+
## Example using latest sharding configurations with independent shard scaling in the cluster
3939

4040
```terraform
4141
resource "mongodbatlas_advanced_cluster" "example" {

docs/data-sources/advanced_clusters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ data "mongodbatlas_advanced_clusters" "example" {
3434
}
3535
```
3636

37-
## Example using latest sharding schema with independent shard scaling in the cluster
37+
## Example using latest sharding configurations with independent shard scaling in the cluster
3838

3939
```terraform
4040
resource "mongodbatlas_advanced_cluster" "example" {

docs/guides/1.18.0-upgrade-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The Terraform MongoDB Atlas Provider version 1.18.0 has a number of new and exci
1010

1111
**New Resources, Data Sources, and Features:**
1212

13-
- You can now scale the instance size and disk IOPS independently for each individual shard for sharded and geo-sharded clusters defined with `mongodbatlas_advanced_cluster`. To learn more, see the [Advanced Cluster New Sharding Schema Migration Guide](advanced-cluster-new-sharding-schema). As part of these changes two new attributes are added:
13+
- You can now scale the instance size and disk IOPS independently for each individual shard for sharded and geo-sharded clusters defined with `mongodbatlas_advanced_cluster`. To learn more, see the [Advanced Cluster New Sharding Configurations Migration Guide](advanced-cluster-new-sharding-schema). As part of these changes two new attributes are added:
1414
- Use the `replication_specs.*.zone_id` attribute in the `mongodbatlas_advanced_cluster` resource and data sources to identify the zone of each `replication_specs` object.
1515
- Use the `use_replication_spec_per_shard` attribute in the `mongodbatlas_advanced_cluster` data sources to specify whether to obtain `replication_specs` objects for each shard.
1616

docs/guides/advanced-cluster-new-sharding-schema.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
---
2-
page_title: "Migration Guide: Advanced Cluster New Sharding Schema"
2+
page_title: "Migration Guide: Advanced Cluster New Sharding Configurations"
33
---
44

5-
# Migration Guide: Advanced Cluster New Sharding Schema
5+
# Migration Guide: Advanced Cluster New Sharding Configurations
66

7-
**Objective**: Use this guide to migrate your existing `advanced_cluster` configurations to the new sharding schema introduced in version 1.18.0. The new sharding schema allows you to scale shards independently. Existing sharding configurations continue to work, although the software issues deprecation messages if you use the legacy schema.
7+
**Objective**: Use this guide to migrate your existing `advanced_cluster` resources to support new sharding configurations introduced in version 1.18.0. The new sharding configurations allow you to scale shards independently. Existing sharding configurations continue to work, but you will receive deprecation messages if you continue to use them.
88

9-
- [Migration Guide: Advanced Cluster New Sharding Schema](#migration-guide-advanced-cluster-new-sharding-schema)
10-
- [Overview of schema changes](#overview-of-schema-changes)
9+
- [Migration Guide: Advanced Cluster New Sharding Configurations](#migration-guide-advanced-cluster-new-sharding-schema)
10+
- [Changes Overview](#changes-overview)
1111
- [Migrate advanced\_cluster type `SHARDED`](#migrate-advanced_cluster-type-sharded)
1212
- [Migrate advanced\_cluster type `GEOSHARDED`](#migrate-advanced_cluster-type-geosharded)
1313
- [Migrate advanced\_cluster type `REPLICASET`](#migrate-advanced_cluster-type-replicaset)
1414
- [Use Independent Shard Scaling](#use-independent-shard-scaling)
1515

1616
<a id="overview"></a>
17-
## Overview of schema changes
17+
## Changes Overview
1818

1919
`replication_specs` attribute now represents each individual cluster's shard with a unique replication spec element.
20-
When you use the new sharding schema, the schema no longer uses the existing attribute `num_shards`, and instead the number of shards are defined by the number of `replication_specs` elements.
20+
When you use the new sharding configurations, it will no longer use the existing attribute `num_shards`, and instead the number of shards are defined by the number of `replication_specs` elements.
2121

2222
<a id="migration-sharded"></a>
2323
### Migrate advanced_cluster type `SHARDED`
@@ -46,7 +46,7 @@ resource "mongodbatlas_advanced_cluster" "test" {
4646
}
4747
```
4848

49-
In order to update our configuration to the new schema, we will remove the use of `num_shards` and add a new identical `replication_specs` element for each shard. Note that these 2 changes must be done at the same time.
49+
In order to use our new sharding configurations, we will remove the use of `num_shards` and add a new identical `replication_specs` element for each shard. Note that these 2 changes must be done at the same time.
5050

5151
```
5252
resource "mongodbatlas_advanced_cluster" "test" {
@@ -128,7 +128,7 @@ resource "mongodbatlas_advanced_cluster" "test" {
128128
}
129129
```
130130

131-
In order to update our configuration to the new schema, we will remove the use of `num_shards` and add a new identical `replication_specs` element for each shard. Note that these two changes must be done at the same time.
131+
In order to use our new sharding configurations, we will remove the use of `num_shards` and add a new identical `replication_specs` element for each shard. Note that these two changes must be done at the same time.
132132

133133
```
134134
resource "mongodbatlas_advanced_cluster" "test" {
@@ -244,7 +244,7 @@ resource "mongodbatlas_advanced_cluster" "test" {
244244
}
245245
```
246246

247-
Once the cluster type is adjusted accordingly, we can proceed to add a new shard using the new schema:
247+
Once the cluster type is adjusted accordingly, we can proceed to add a new shard:
248248

249249
```
250250
resource "mongodbatlas_advanced_cluster" "test" {
@@ -283,7 +283,7 @@ Note: The first time `terraform apply` command is run **after** updating the con
283283
<a id="use-iss"></a>
284284
### Use Independent Shard Scaling
285285

286-
Use the new sharding schema. Each shard must be represented with a unique replication_specs element and `num_shards` must not be used, as illustrated in the following example.
286+
Use the new sharding configurations. Each shard must be represented with a unique `replication_specs` element and `num_shards` must not be used, as illustrated in the following example.
287287

288288
```
289289
resource "mongodbatlas_advanced_cluster" "test" {
@@ -353,4 +353,4 @@ resource "mongodbatlas_advanced_cluster" "test" {
353353
}
354354
```
355355

356-
-> **NOTE:** For any cluster leveraging the new schema and defining independently scaled shards, users should also update corresponding `mongodbatlas_cloud_backup_schedule` resource & data sources. This involves updating any existing Terraform configurations of the resource to use `copy_settings.#.zone_id` instead of `copy_settings.#.replication_spec_id`. This is needed as `mongodbatlas_advanced_cluster` resource and data source will no longer have `replication_specs.#.id` present when shards are scaled independently. To learn more, review the [1.18.0 Migration Guide](1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).
356+
-> **NOTE:** For any cluster leveraging the new sharding configurations and defining independently scaled shards, users should also update corresponding `mongodbatlas_cloud_backup_schedule` resource & data sources. This involves updating any existing Terraform configurations of the resource to use `copy_settings.#.zone_id` instead of `copy_settings.#.replication_spec_id`. This is needed as `mongodbatlas_advanced_cluster` resource and data source will no longer have `replication_specs.#.id` present when shards are scaled independently. To learn more, review the [1.18.0 Migration Guide](1.18.0-upgrade-guide.md#transition-cloud-backup-schedules-for-clusters-to-use-zones).

docs/guides/cluster-to-advanced-cluster-migration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ page_title: "Migration Guide: Cluster to Advanced Cluster"
1212
2. Provider Settings: Moved from the top level to the replication spec allowing you to create multi-cloud clusters.
1313
3. Auto Scaling: Moved from the top level to the replication spec allowing you to scale replication specs individually.
1414
4. Backup Configuration: Renamed from `cloud_backup` to `backup_enabled`.
15-
5. See the [Migration Guide: Advanced Cluster New Sharding Schema](advanced-cluster-new-sharding-schema#migration-sharded) for changes to `num_shards` and the new `zone_id`.
15+
5. See the [Migration Guide: Advanced Cluster New Sharding Configurations](advanced-cluster-new-sharding-schema#migration-sharded) for changes to `num_shards` and the new `zone_id`.
1616

1717
### Example 1: Old Configuration (`mongodbatlas_cluster`)
1818

docs/resources/advanced_cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ This parameter defaults to false.
383383
* `labels` - (Optional) Set that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. See [below](#labels). **DEPRECATED** Use `tags` instead.
384384
* `mongo_db_major_version` - (Optional) Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10+ clusters: `4.4`, `5.0`, `6.0` or `7.0`. If omitted, Atlas deploys a cluster that runs MongoDB 7.0. If `replication_specs#.region_configs#.<type>Specs.instance_size`: `M0`, `M2` or `M5`, Atlas deploys MongoDB 4.4. Atlas always deploys the cluster with the latest stable release of the specified version. If you set a value to this parameter and set `version_release_system` `CONTINUOUS`, the resource returns an error. Either clear this parameter or set `version_release_system`: `LTS`.
385385
* `pit_enabled` - (Optional) - Flag that indicates if the cluster uses Continuous Cloud Backup.
386-
* `replication_specs` - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec `num_shards` is configured with a value greater than 1 (using deprecated sharding schema), then each object represents a zone with one or more shards. See [below](#replication_specs)
386+
* `replication_specs` - List of settings that configure your cluster regions. This attribute has one object per shard representing node configurations in each shard. For replica sets there is only one object representing node configurations. If for each replication_spec `num_shards` is configured with a value greater than 1 (using deprecated sharding configurations), then each object represents a zone with one or more shards. See [below](#replication_specs)
387387
* `root_cert_type` - (Optional) - Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).
388388
* `termination_protection_enabled` - Flag that indicates whether termination protection is enabled on the cluster. If set to true, MongoDB Cloud won't delete the cluster. If set to false, MongoDB Cloud will delete the cluster.
389389
* `version_release_system` - (Optional) - Release cadence that Atlas uses for this cluster. This parameter defaults to `LTS`. If you set this field to `CONTINUOUS`, you must omit the `mongo_db_major_version` field. Atlas accepts:

0 commit comments

Comments
 (0)