doc: Examples for advanced_cluster preview v2 #3054

lantoli · 2025-02-11T15:31:22Z

Description

Examples for advanced_cluster preview v2.

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

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 · 2025-02-11T17:12:28Z

examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md

keep AWS so region_name is valid

lantoli · 2025-02-12T07:27:35Z

unit tests errors are not related to changes in this PR

lantoli · 2025-02-12T07:29:38Z

i merged by mistake, but if you have any comment please let me know and will address in a following-up PR

EspenAlbert · 2025-02-12T08:56:45Z

examples/mongodbatlas_advanced_cluster (preview v2)/asymmetric-sharded-cluster/README.md

@@ -4,12 +4,12 @@ This example creates a project and a Sharded Cluster with 4 independent shards w

 ## Dependencies

-* Terraform MongoDB Atlas Provider v1.18.0
+* Terraform MongoDB Atlas Provider v1.27.0


Are we locking in on 1.27? Makes sense to me, if there for some reason is another release before, we can always change it

that was my thought, it won't be available in previous version, if not in 1.27 we can change again

EspenAlbert · 2025-02-12T08:59:20Z

examples/mongodbatlas_advanced_cluster (preview v2)/tenant-upgrade/README.md

@@ -25,8 +25,8 @@ provider_instance_size_name = "M2"

 Apply with the following `terraform.tfvars` to upgrade the shared tier cluster you just created to dedicated tier:
 ```
-atlas_org_id                = "627a9687f7f7f7f774de306f14"
+atlas_org_id                = <REDACTED>


Don't know why we are using REDACTED here. Instead of {ORG_ID} or {PLACEHOLDER} or something else

it's in the spirit of they can use their own org_id, I think it's confusing to have a hardcoded value, in this way they don't they have to enter their own org_id. not strong opinion about change it to {ORG_ID} although it looks like it's a variable, in current way I think it's more clear that they need to enter the number of the org_id

at the end I've changed it here: #3059

EspenAlbert · 2025-02-12T09:00:38Z

examples/mongodbatlas_advanced_cluster (preview v2)/tenant-upgrade/main.tf

        instance_size = var.provider_instance_size_name
      }
      provider_name         = var.provider_name
-      backing_provider_name = var.backing_provider_name
+      backing_provider_name = var.backing_provider_name # comment out when upgrading


why comment out? Can the user set backing_provider_name=null instead?

you're right, tested it here: #3059

it doesn't work if the user introduces the variable value, because it's "" if nothing is entered, but works if it has default null

EspenAlbert

Approved. Left a few nit comments

) * 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]>

root readme

039897c

lantoli changed the base branch from master to CLOUDP-274025-dev-docs-examples February 11, 2025 15:36

lantoli added 2 commits February 11, 2025 18:06

fix example as used region doesn't exist in GCP

45035a9

change examples

1e9c343

lantoli marked this pull request as ready for review February 11, 2025 17:10

lantoli requested a review from a team as a code owner February 11, 2025 17:10

lantoli commented Feb 11, 2025

View reviewed changes

examples/mongodbatlas_advanced_cluster/tenant-upgrade/README.md

provider_name = "AWS"

Copy link

Member Author

lantoli Feb 11, 2025

Choose a reason for hiding this comment

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

keep AWS so region_name is valid

lantoli added 2 commits February 11, 2025 19:05

undo comment

a2b0056

doc for backing_provider_name

eb858ce

lantoli merged commit c64b251 into CLOUDP-274025-dev-docs-examples Feb 12, 2025
13 of 14 checks passed

lantoli deleted the CLOUDP-299308-examples-preview-v2 branch February 12, 2025 07:27

EspenAlbert reviewed Feb 12, 2025

View reviewed changes

lantoli mentioned this pull request Feb 12, 2025

chore: Follow-up for PR 3054 #3059

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Examples for advanced_cluster preview v2 #3054

doc: Examples for advanced_cluster preview v2 #3054

lantoli commented Feb 11, 2025 •

edited

Loading

lantoli Feb 11, 2025

lantoli commented Feb 12, 2025

lantoli commented Feb 12, 2025

EspenAlbert Feb 12, 2025 •

edited

Loading

lantoli Feb 12, 2025

EspenAlbert Feb 12, 2025

lantoli Feb 12, 2025

lantoli Feb 12, 2025

EspenAlbert Feb 12, 2025

lantoli Feb 12, 2025

EspenAlbert left a comment

doc: Examples for advanced_cluster preview v2 #3054

doc: Examples for advanced_cluster preview v2 #3054

Conversation

lantoli commented Feb 11, 2025 • edited Loading

Description

Type of change:

Required Checklist:

Further comments

lantoli Feb 11, 2025

Choose a reason for hiding this comment

lantoli commented Feb 12, 2025

lantoli commented Feb 12, 2025

EspenAlbert Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

lantoli Feb 12, 2025

Choose a reason for hiding this comment

EspenAlbert Feb 12, 2025

Choose a reason for hiding this comment

lantoli Feb 12, 2025

Choose a reason for hiding this comment

lantoli Feb 12, 2025

Choose a reason for hiding this comment

EspenAlbert Feb 12, 2025

Choose a reason for hiding this comment

lantoli Feb 12, 2025

Choose a reason for hiding this comment

EspenAlbert left a comment

Choose a reason for hiding this comment

lantoli commented Feb 11, 2025 •

edited

Loading

EspenAlbert Feb 12, 2025 •

edited

Loading