doc: Adds examples for advanced_cluster upgrade to v2.0 & improves documentation #3767
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,28 +1,32 @@ | ||
| --- | ||
| page_title: "Guide: Advanced Cluster New Sharding Configurations" | ||
| --- | ||
|
|
||
|
|
||
| **Objective**: This guide explains the new sharding configuration for `mongodbatlas_advanced_cluster` that allows you to scale shards independently, hence, you may also come across the term "Independent shard scaling configuration" in our documentation. | ||
| Additionally, compute auto-scaling supports scaling instance sizes independently for each shard when using the new sharding configuration. | ||
|
|
||
| **You may find this guide useful if:** | ||
| - You are considering upgrading from v1.x of our provider to v2.0.0 or later which ONLY supports this new configuration. | ||
| - You currently use the legacy sharding schema (i.e. using `num_shards` which was deprecated in v1.18.0 and removed in 2.0.0). | ||
| - You want to understand the new sharding configuration and how a `replication_specs` element now represents each shard individually, allowing you to scale or modify each shard independently. | ||
| - You are considering upgrading to a sharded cluster and you want to understand the new sharding configuration. | ||
|
|
||
|
|
||
| If you are still using the deprecated `mongodbatlas_cluster` resource, use [Migration Guide: Cluster → Advanced Cluster instead](./cluster-to-advanced-cluster-migration-guide.md). | ||
|
|
||
| If you are already using `mongodbatlas_advanced_cluster` and want to upgrade to our Terraform Provider v2.0.0 or later from v1.x, also review [Migration Guide: Moving to Advanced Cluster v2.0.0](./migrate-to-advanced-cluster-2.0.md) | ||
| --- | ||
|
|
||
| - [Changes Overview](#changes-overview) | ||
| - [Migrate advanced\_cluster type `SHARDED`](#migrate-advanced_cluster-type-sharded) | ||
| - [Migrate advanced\_cluster type `GEOSHARDED`](#migrate-advanced_cluster-type-geosharded) | ||
| - [Upgrade type `REPLICASET` to `SHARDED`](#migrate-advanced_cluster-type-replicaset) | ||
|
There was a problem hiding this comment. curious: why the need to updating the link name here? The previous one was more consistent with the other two links There was a problem hiding this comment. because if you look at the contents of this section it doesn't talk about "Migrating", this is what it starts with for example, There was a problem hiding this comment. but why don't we have one migrate for There was a problem hiding this comment. My understanding is it only involves removing There was a problem hiding this comment.
Correct, and most likely a replica set does not define |
||
| - [Use Independent Shard Scaling](#use-independent-shard-scaling) | ||
| - [Use Auto-Scaling Per Shard](#use-auto-scaling-per-shard) | ||
| - [Resources and Data Sources Impacted by Independent Shard Scaling](#resources-and-data-sources-impacted-by-independent-shard-scaling) | ||
| - [Data Source Transition for Asymmetric Clusters](#data-source-transition-for-asymmetric-clusters) | ||
|
|
||
|
|
||
| ## Changes Overview | ||
|
|
||
|
|
@@ -189,7 +193,7 @@ resource "mongodbatlas_advanced_cluster" "test" { | |
| } | ||
| ``` | ||
|
|
||
| ### Upgrade type `REPLICASET` to `SHARDED` | ||
|
|
||
| To learn more, see the documentation on [transitioning from a replica set to a sharded cluster](https://www.mongodb.com/docs/atlas/scale-cluster/#scale-your-replica-set-to-a-sharded-cluster). | ||
|
|
||
|
|
@@ -424,6 +428,7 @@ While the example initially defines 2 symmetric shards, auto-scaling of `electab | |
|
|
||
| -> **NOTE:** See the table [below](#resources-and-data-sources-impacted-by-independent-shard-scaling) for other impacted resources when a cluster transitions to independently scaled shards. | ||
|
|
||
|
|
||
| ## Resources and Data Sources Impacted by Independent Shard Scaling | ||
|
|
||
| Name | Changes | Transition Guide | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let me know if you want me to generate a personal provider doc to check links and format
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes lets do that, ty!