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.

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
merged 5 commits into from
Apr 16, 2025

Conversation

oarbusi
Copy link
Collaborator

@oarbusi oarbusi commented Apr 4, 2025

Description

Mention import operation on use auto-scaling per shard documentation

Link to any related issue(s): CLOUDP-308513

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals I have added appropriate changelog entries.
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Further comments

@oarbusi oarbusi marked this pull request as ready for review April 4, 2025 07:52
@oarbusi oarbusi requested a review from a team as a code owner April 4, 2025 07:52
Copy link
Contributor

github-actions bot commented Apr 4, 2025

APIx bot: a message has been sent to Docs Slack channel

@@ -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
Member

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
Collaborator Author

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?

Copy link
Contributor

@corryroot corryroot left a comment

Choose a reason for hiding this comment

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

LGTM! I commented with some small copy fixes.

Copy link
Contributor

This PR has gone 7 days without any activity and meets the project’s definition of "stale". This will be auto-closed if there is no new activity over the next 7 days. If the issue is still relevant and active, you can simply comment with a "bump" to keep it open, or add the label "not_stale". Thanks for keeping our repository healthy!

@github-actions github-actions bot added the stale label Apr 13, 2025
@github-actions github-actions bot closed this Apr 16, 2025
@oarbusi oarbusi reopened this Apr 16, 2025
Copy link
Member

@AgustinBettati AgustinBettati left a comment

Choose a reason for hiding this comment

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

Thank you for the follow ups 👌

@oarbusi oarbusi merged commit 6a1cb72 into master Apr 16, 2025
40 checks passed
@oarbusi oarbusi deleted the CLOUDP-308513 branch April 16, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants