Skip to content

doc: Mention import operation on use auto-scaling per shard documentation #3248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oarbusi merged 5 commits into from
Apr 16, 2025
Merged

doc: Mention import operation on use auto-scaling per shard documentation #3248

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7178e45
mention import
oarbusi Apr 4, 2025
7787a81
remove extra line
oarbusi Apr 4, 2025
8c028f8
pr suggestion
oarbusi Apr 4, 2025
e8383e6
Update docs/guides/advanced-cluster-new-sharding-schema.md
oarbusi Apr 16, 2025
af3e08b
Update docs/guides/advanced-cluster-new-sharding-schema.md
oarbusi Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/guides/advanced-cluster-new-sharding-schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,8 @@ While the example initially defines 2 symmetric shards, auto-scaling of `electab

-> **NOTE:** After you upgrade to version 1.23.0 of the provider, you must update the cluster configuration to activate the auto-scaling per shard feature.

-> **NOTE:** For imported clusters, you must also update the configuration to enable per-shard auto-scaling, otherwise it will operate in cluster-wide mode.
Copy link
Copy Markdown
Member

@AgustinBettati AgustinBettati Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This statement can be misinterpreted, a imported cluster that was already using latest ISS config can have shard mode. Maybe we can unify with the note above and mention something like:

There can be specific scenarios in which you reach an advanced_cluster configuration using new sharding configuration but does not have shard-level auto-scaling:

  • Configuration using single replication_specs per shard was defined prior to version 1.23.0 in which auto-scaling per shard feature was released.
  • Cluster defined with legacy schema (e.g. mongodbatlas_cluster or mongodbatlas_advanced_cluster using num_shards > 1) is imported into mongodbatlas_advanced_cluster using single replication_specs per shard.

For these scenarios an update to the cluster configuration must be made to activate the auto-scaling per shard feature. An example for achieving this can be temprorily modifying the value of compute_min_instance.

Copy link
Copy Markdown
Collaborator Author

@oarbusi oarbusi Apr 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion. What do you think of the changes in 8c028f8?


-> **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
Expand Down