Skip to content
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

Jump to bottom

CLOUDP-234797: Update docs about upgrades from replica sets to multi-… #2786

Merged
merged 5 commits into from Mar 20, 2024
Merged

CLOUDP-234797: Update docs about upgrades from replica sets to multi-… #2786

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
361a02a
CLOUDP-234797: Update docs about upgrades from replica sets to multi-…
blva Mar 19, 2024
07eddcc
Update text
blva Mar 19, 2024
37048d9
Merge branch 'master' into CLOUDP-234797
blva Mar 19, 2024
8c218d9
Merge branch 'master' into CLOUDP-234797
blva Mar 20, 2024
995b3e6
Address copy comments
blva Mar 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/command/atlas-clusters-update.txt
View file
Open in desktop
Expand Up @@ -18,6 +18,8 @@ You can specify modifications in a JSON configuration file with the --file flag.

You can't change the name of the cluster or downgrade the MongoDB version of your cluster.

You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
blva marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy suggestions -- take a firm position that this isn't allowed (can not vs. must not), reorganize sentence structure a little bit to present more context to the user at the start of each one:

Suggested change
You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster.
To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks! looks better


To use this command, you must authenticate with a user account or an API key with the Project Cluster Manager role.
Atlas supports this command only for M10+ clusters

Expand Down
2 changes: 2 additions & 0 deletions internal/cli/atlas/clusters/update.go
View file
Open in desktop
Expand Up @@ -146,6 +146,8 @@ func UpdateBuilder() *cobra.Command {

You can't change the name of the cluster or downgrade the MongoDB version of your cluster.

You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment applies here if you change the other paragraph

Suggested change
You must not update a replica set to a multi-sharded cluster, only single-sharded cluster is supported. See https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster for more information on this type of update.
You can only update a replica set to a single-shard cluster; you cannot update a replica set to a multi-sharded cluster. To learn more, see https://www.mongodb.com/docs/atlas/scale-cluster/#convert-a-replica-set-to-a-sharded-cluster and https://www.mongodb.com/docs/upcoming/tutorial/convert-replica-set-to-replicated-shard-cluster.


` + fmt.Sprintf("%s\n%s", fmt.Sprintf(usage.RequiredRole, "Project Cluster Manager"), "Atlas supports this command only for M10+ clusters"),
Example: ` # Update the tier for a cluster named myCluster for the project with ID 5e2211c17a3e5a48f5497de3:
atlas cluster update myCluster --projectId 5e2211c17a3e5a48f5497de3 --tier M50
Expand Down