Skip to content

doc: Updates guide cluster to advanced_cluster and creates guide advanced_cluster preview provider v2 #3071

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
Merged
merged 7 commits into from
Feb 14, 2025
Merged

doc: Updates guide cluster to advanced_cluster and creates guide advanced_cluster preview provider v2 #3071

merged 7 commits into from
Feb 14, 2025

Conversation

lantoli
Copy link
Member

@lantoli lantoli commented Feb 14, 2025 •
edited
Loading

Description

Updates guide cluster to advanced_cluster and creates guide advanced_cluster preview provider v2

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

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

@lantoli lantoli marked this pull request as ready for review February 14, 2025 16:24
@lantoli lantoli requested a review from a team as a code owner February 14, 2025 16:24
@github-actions GitHub Actions
Copy link
Contributor

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

EspenAlbert
EspenAlbert approved these changes Feb 14, 2025
View reviewed changes
Copy link
Collaborator

@EspenAlbert EspenAlbert left a comment

Choose a reason for hiding this comment

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

Nice!

@lantoli lantoli merged commit ced477c into CLOUDP-274025-dev-docs-examples Feb 14, 2025
40 checks passed
@lantoli lantoli deleted the CLOUDP-299310-guides branch February 14, 2025 17:27
AgustinBettati
AgustinBettati reviewed Feb 17, 2025
View reviewed changes
docs/guides/cluster-to-advanced-cluster-migration-guide.md
@@ -6,7 +6,10 @@ page_title: "Migration Guide: Cluster to Advanced Cluster"

**Objective**: This guide explains how to replace the `mongodbatlas_cluster` resource with the `mongodbatlas_advanced_cluster` resource. The data source(s) migration only requires [output changes](#output-changes) as data sources only read clusters.

**Note**: In addition to below options, we are also actively exploring additional migration paths that do not involve Terraform State modifications. If interested to learn more or to test out directly please contact [email protected].
**Note**: Please look at the section [Moved block](#moved-block) below for an improved migration path. We are also exploring additional migration paths that do not involve Terraform State modifications. If interested to learn more or to test out directly please contact [email protected].
Copy link
Member

Choose a reason for hiding this comment

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

What possible options do we have when we refer to We are also exploring additional migration paths that do not involve Terraform State modifications.?

Copy link
Member Author

Choose a reason for hiding this comment

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

Melissa wanted to keep its contact info some time, WDYT about removing that part and have the sentence like:

 We are also exploring additional migration paths. If ...

Copy link
Member Author

Choose a reason for hiding this comment

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

following this up in this PR: #3075

docs/guides/cluster-to-advanced-cluster-migration-guide.md
- Add the `mongodbatlas_advanced_cluster` resource definition.
- Make sure environment variable `MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_CLUSTER=true` is set in order to use the Preview for MongoDB Atlas Provider v2.
- The [Atlas CLI plugin](https://github.com/mongodb-labs/atlas-cli-plugin-terraform) can be used to generate the `mongodbatlas_advanced_cluster` resource definition. This is the recommended method as it will generate a clean configuration keeping the original Terraform expressions.
- Alternatively, you can use the `terraform plan -generate-config-out=adv_cluster.tf` method to create the `mongodbatlas_advanced_cluster` resource definition, or create it manually.
Copy link
Member

Choose a reason for hiding this comment

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

Should we reiterate that MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_CLUSTER=true should be exported so that generated config is using v2 config?

Copy link
Member Author

@lantoli lantoli Feb 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

isn't that what we're saying in line 200, just a bit above? where would you reiterate it?

Copy link
Member

Choose a reason for hiding this comment

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

yeah thats okay, it assumes all terraform commands being run after that statement have the env variable configured

docs/guides/advanced-cluster-preview-provider-v2.md
- Before starting, run `terraform plan` to make sure that there are no planned changes.
- Set environment variable `MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_CLUSTER=true` in order to use the Preview for MongoDB Atlas Provider v2.
- Run `terraform plan` and you'll see errors as definition file hasn't been updated yet.
- Apply definition changes explained in previous section until there are no errors and no planned changes. **Important**: Don't apply until plan is empty. If it shows other changes, you will need to keep updating the `mongodb_atlas_advanced_cluster` configuration until it matches the original configuration.
Copy link
Member

Choose a reason for hiding this comment

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

should we add a note that defining env variable in local development environment can helping with autocompletion and linting?

Copy link
Member Author

Choose a reason for hiding this comment

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

following this up in this PR: #3075

@lantoli lantoli mentioned this pull request Feb 17, 2025
Merged
13 tasks
lantoli added a commit that referenced this pull request Mar 11, 2025
@lantoli @EspenAlbert
@carriecwk @marcosuma @maastha @oarbusi @jwilliams-mongo @themantissa
doc: Merges CLOUDP-274025 docs & examples branch - DONT MERGE YET (#3079
015ba58 
)

* duplicate files (#3046)

* doc: Adds initial structure for module examples cluster_to_advanced_cluster (#3043)

* doc: Adds initial structure for module example cluster_to_advanced_cluster

* chore: fix lint errors

* refactor: directory move

* doc: Initial module_user

* doc: Remove hcl simplification purpose (most likely done only in module_maintainer)

* Update examples/migrate_cluster_to_advanced_cluster/module_maintainer/README.md

Co-authored-by: Leo Antoli <[email protected]>

* address PR comments

---------

Co-authored-by: Leo Antoli <[email protected]>

* duplicate files (#3052)

* doc: Examples for advanced_cluster preview v2 (#3054)

* root readme

* fix example as used region doesn't exist in GCP

* change examples

* undo comment

* doc for backing_provider_name

* doc: Create doc pages for `mongodb_advanced_cluster` schema v2 resource and data sources (#3048)

* add doc references at the beginning of the doc

* examples

* replace replication_specs.#

* leftover

* connection_strings

* Move and other changes

* rename schema to preview

* ds

* fix defaultMaxTimeMS links

* fix typo region_config

* Update docs/data-sources/advanced_clusters (preview v2).md

Co-authored-by: carriecwk <[email protected]>

* Update docs/resources/advanced_cluster.md

Co-authored-by: carriecwk <[email protected]>

* apply feedback

---------

Co-authored-by: carriecwk <[email protected]>

* chore: Follow-up for PR 3054 (#3059)

* null default value

* org id

* doc: Rename env. var. to `MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_CLUSTER` (#3064)

* rename env. var. to MONGODB_ATLAS_PREVIEW_PROVIDER_V2_ADVANCED_CLUSTER

* change example doc

* update links and menu items

* fix links

* change style

* doc: Implements v2 and v3 MongoDB Atlas cluster migration examples (#3050)

* initial v2 & v3 implementations

* Adds `v2` Implementation Changes and Highlights

* doc: Update README with v3 implementation changes and highlights

* doc: Update README and add v1_v2 and v3 variable files for cluster migration examples

* style: fmt

* doc: Fix v3 usage of cluster data source

* feat: Add output for MongoDB connection strings in v1, v2, and v3 examples

* style: fmt

* chore: Enable Advanced Cluster V2 Schema validation in tf-validate script

* fix lint errors

* feat: Add function to check for V2 schema directories in tf-validate script

* refactor: Use approach 1 (file headings) rather than a table

* address PR comments

* docs: Update README files to enhance migration guidance for mongodbatlas_cluster to mongodbatlas_advanced_cluster

* address PR comments

* chore: Update ToC

* Review suggestions

* update var name

* docs: Enhance README to clarify standalone usage and upgrade support for module_maintainer

* fix: Update required_version comment for clarity in versions.tf files

* docs: Add v3_no_plan_changes and step for ensuring no changes when using new `replication_specs_new` variable

* update var name to make tf-validate pass

* fix: Update environment variable for Terraform validation in v2 schema

* docs: Update ToC

* fix: update restore command in tf-validate script to use preview_provider_v2.go

* doc: Adds migration example from `mongodbatlas_cluster` to `mongodbatlas_advanced_cluster` (#3058)

* doc: Adds migration example from `mongodbatlas_cluster` to `mongodbatlas_advanced_cluster`

* rename directory and example

* chore: use a Note to warn about creating a `mongodbatlas_cluster` and more details

* add review suggestions

* support using v2 schema in basic

* doc: Updates guide cluster to advanced_cluster and creates guide advanced_cluster preview provider v2 (#3071)

* new guide

* update docs

* some adjustements

* typos

* feedback

* best practices feedback

* fix identation

* doc: Adds remaining work to migrate_cluster_to_advanced_cluster examples (#3065)

* handle todos

* doc: Fix link in README for replication_specs in advanced cluster migration example

* doc: Enhance variable descriptions in migration examples

* doc: Update descriptions for outputs

* doc: Change regions_config type from set to list in replication_specs variable (otherwise priority order failure)

* doc: Change regions_config type from set to list in replication_specs variable (otherwise priority order failure)

* doc: Applies some feedback for migration guides doc (#3075)

* remove part about state

* add doc about using the env var locally

* doc: Updates table formatting and migration guides (#3076)

* doc: Updates table formatting

* clarify how to migrate

* change order

* move block section down

* apply feedback

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: Marco Suma <[email protected]>

---------

Co-authored-by: Leo Antoli <[email protected]>
Co-authored-by: Marco Suma <[email protected]>

* fix mongodb_atlas typo

* address PR comments

* doc: Clarify purpose of migration example for Terraform module

* clarify when to use alternative

* own section for env.var.

* change option to use Import

* adjust step

* refactor: Improve formatting and consistency in preview provider v2 examples

* typo dot in deprecated

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: maastha <[email protected]>

* style: add linebreaks to examples

* chore: Adds Flex GA documentation changes (#3087)

* Update examples/migrate_cluster_to_advanced_cluster/basic/README.md

Co-authored-by: Oriol <[email protected]>

* remove M0 info as it can be seen in Atlas doc

* plural ds description

* change migration guide title

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: Oriol <[email protected]>

* move output example

* doc: Adds examples for flex clusters in mongodbatlas_advanced_cluster in v2 examples (#3097)

* doc: Missing backported docs & followup (#3098)

* missing docs & followup

* v2 change

* missing changein v2

* Update examples/migrate_cluster_to_advanced_cluster/module_user/README.md

Co-authored-by: John Williams <[email protected]>

* rename Tags to tags

* remove "l" leftover

* typo add blank after dot

* typo

* unify [#]

* uppercase Flex

* adv cluster doc sync with v2

* align data sources

* Add docs suggestions

* apply feedback

* fix incorrect database reference in project_id

* add dot

* more dots added

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: John Williams <[email protected]>

* bi_connector

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/advanced-cluster-preview-provider-v2.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: John Williams <[email protected]>

* remove "of a specs"

* order list

* change doc and info

* typo

* plural ds link

* update README in examples

* plugin limitations

* set old guides for 1.14.0 and 1.15.0 as they were published more than 1 year ago

* update examples provider version to 1.29

* v2 to 2.0.0

* move "main changes" section to resource doc page

* remove adv_cluster guide and move content to upgrade guide and resource page

* wip

* updates documentation.

* Update README.md file for the basic example.

* Update README.md file for the module example.

* syntax changes.

* fix tflint

* rename filenames from v2 to 2.0.0

* change links v2 to 2.0.0

* fix tflint for migration examples

* typo

* fix order in import process

* add reference update step

* update examples with todo and findings from demo branch `CLOUDP-299313_DO_NOT_DELETE_demo_tpf_adv_cluster_big`

* update tf-validate

* id to cluster_id

* Apply suggestions from code review

Co-authored-by: John Williams <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>

* address initial comments.

* add a main README.md file for the examples folder.

* move Terraform Actions doc

* small typo

* use explicit numbering

* change version requirement for v1 of the examples

* Update examples/migrate_cluster_to_advanced_cluster/README.md

Co-authored-by: Oriol <[email protected]>

* Update examples/migrate_cluster_to_advanced_cluster/basic/README.md

Co-authored-by: Oriol <[email protected]>

* add coming soon for plugin

* get plugin alternatives back

* update plugin doc

* change section

* indent coming soon

* same line for coming soon

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: Marco Suma <[email protected]>

* Update docs/guides/cluster-to-advanced-cluster-migration-guide.md

Co-authored-by: Marco Suma <[email protected]>

* remove refs to cli plugin and fix text for the 'import+remove' approach.

* make some titles shorter.

---------

Co-authored-by: Espen Albert <[email protected]>
Co-authored-by: carriecwk <[email protected]>
Co-authored-by: Marco Suma <[email protected]>
Co-authored-by: Espen Albert <[email protected]>
Co-authored-by: maastha <[email protected]>
Co-authored-by: Oriol <[email protected]>
Co-authored-by: John Williams <[email protected]>
Co-authored-by: Melissa Plunkett <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EspenAlbert EspenAlbert EspenAlbert approved these changes

@AgustinBettati AgustinBettati AgustinBettati left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lantoli @EspenAlbert @AgustinBettati