doc: Updates table formatting and migration guides #3076
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lantoli
approved these changes
Feb 17, 2025
lantoli
changed the title
|
|
||
| You can find full-detailed examples in [migrate_cluster_to_advanced_cluster](https://github.com/mongodb/terraform-provider-mongodbatlas/tree/master/examples/migrate_cluster_to_advanced_cluster). | ||
|
|
||
| ## Manual migration |
There was a problem hiding this comment.
nit: This section feels a little disconnected as I am not clear what part of the migration is manual. Does this refer to manual config changes? Maybe you can state this would be an alternative to using the CLI, and moved or remove/import can still be used for state manipulation.
There was a problem hiding this comment.
i've changed to the original format, can you review the latest changes again and see if it's fine?
marcosuma
reviewed
Feb 17, 2025
| Before doing any migration create a backup of your [Terraform state file](https://developer.hashicorp.com/terraform/cli/commands/state). | ||
|
|
||
| ## Main Changes Between `mongodbatlas_cluster` and `mongodbatlas_advanced_cluster` | ||
| ## Migration using Moved block (preferred) |
There was a problem hiding this comment.
@lantoli I think this section is now "too high" :) It should go right before
## Migration using `terraform plan -generate-config-out=adv_cluster.tf`
otherwise it's hard to follow
There was a problem hiding this comment.
Also in the section
## Migration using `terraform plan -generate-config-out=adv_cluster.tf`
``` (line 119)
we should re-emphasise that `moved` is recommended. In addition we should also say that if they are moving they with that guide our recommendation is to do it following the latest schema (hence use the ENV VAR)
There was a problem hiding this comment.
added more emphasis here: 0a1574d
marcosuma
requested changes
Feb 17, 2025
marcosuma
reviewed
Feb 17, 2025
marcosuma
approved these changes
Feb 17, 2025
Co-authored-by: Marco Suma <[email protected]>
lantoli
added a commit
that referenced
this pull request
Mar 11, 2025
) * 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates table formatting and migration guides.
Link to any related issue(s): CLOUDP-274025
Type of change:
Required Checklist:
Further comments