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.

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

fix: Removes update logic for the global_cluster_config resource. #2282

Merged
merged 8 commits into from
May 21, 2024

Conversation

marcosuma
Copy link
Collaborator

@marcosuma marcosuma commented May 15, 2024

Description

More info on https://jira.mongodb.org/browse/HELP-59447

tl;dr: updating the global_cluster_config resource leaves the collection and index in an inconsistent state because they are on the data plane side and they would remain unchanged.
That's also why the API does not have any PATCH endpoint.

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 defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • 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

@marcosuma marcosuma changed the title chore: Removes update logic. fix: Removes update logic for the global_cluster_config resource. May 17, 2024
@github-actions github-actions bot added the bug label May 17, 2024
@marcosuma marcosuma marked this pull request as ready for review May 17, 2024 06:25
@marcosuma marcosuma requested review from a team as code owners May 17, 2024 06:25
Copy link
Contributor

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

@@ -13,6 +13,7 @@ description: |-

-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.

~> **IMPORTANT:** A Global Cluster Configuration, once created, can only be deleted and never re-created again with the same data if not without the help of the Atlas UI. This is because the configuration and its related collection with shard key and indexes are managed separately and they would end up in an inconsistent state. [Read more about Global Cluster Configuration](https://www.mongodb.com/docs/atlas/global-clusters/)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should we include about this in the release guide too?
Not sure if this should be considered a breaking change, I understand we are removing an incorrect behavior (just thinking out loud)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It should not be considered a breaking change because it's a bug. I wasn't planning to put it in the release guide, but let me know otherwise

Copy link
Contributor

@sarahsimpers sarahsimpers left a comment

Choose a reason for hiding this comment

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

LGTM with minor suggestion

website/docs/r/global_cluster_config.html.markdown Outdated Show resolved Hide resolved
@marcosuma marcosuma merged commit f38bb48 into master May 21, 2024
32 checks passed
@marcosuma marcosuma deleted the CLOUDP-249260-update-global-cluster-config branch May 21, 2024 06:27
svc-apix-Bot added a commit that referenced this pull request May 21, 2024
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.

None yet

5 participants