doc: Update doc for adv2v2 command #68

lantoli · 2025-08-25T11:54:51Z

Description

Update doc for adv2v2 command.

In order to review this PR, it's recommended to see the full documention using this link: https://github.com/mongodb-labs/atlas-cli-plugin-terraform/tree/CLOUDP-340590_doc
The whole doc structure has been updated so each command has its own page.

Note: Migration Guide: Advanced Cluster (v1.x → v2.0.0) is not linked yet from README.md adv2v2 command as it's not in master branch yet. It will be added after provider 2.0.0 is released.

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

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

Copilot

Pull Request Overview

This PR updates the documentation structure for the Terraform Atlas CLI plugin by introducing separate documentation pages for each command and consolidating content in the README.

Removes the standalone dynamic block limitations guide
Creates dedicated documentation for clu2adv and adv2v2 commands
Restructures the README to provide a cleaner overview with links to detailed command documentation

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
docs/guide_clu2adv_dynamic_block.md	Removes the standalone guide for dynamic block limitations
docs/command_clu2adv.md	Creates comprehensive documentation for the clu2adv command including usage, examples, and limitations
docs/command_adv2v2.md	Creates comprehensive documentation for the adv2v2 command including usage, examples, and limitations
README.md	Restructures to provide clean overview with links to detailed command documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

docs/command_adv2v2.md

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

EspenAlbert · 2025-08-26T09:58:27Z

README.md

@@ -4,8 +4,33 @@

 This repository contains the Atlas CLI plugin for [Terraform's MongoDB Atlas Provider](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs).

-It has the following commands to help with your Terraform configurations:
- **clusterToAdvancedCluster**: Convert a `mongodbatlas_cluster` Terraform configuration to `mongodbatlas_advanced_cluster` (preview provider 2.0.0).
+## Available Commands


Should this be after installation perhaps?

that's fair, changed here: 646a4e2

AgustinBettati

LGTM

docs/command_clu2adv.md

AgustinBettati · 2025-08-26T10:57:49Z

docs/command_clu2adv.md

+
+If you need to use the plugin for `dynamic` block use cases not yet supported, please send us [feedback](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/issues).
+
+#### Dynamic block and individual blocks in the same resource


Might rephrase this to: Block values defined with combination of dynamic and inline expressions

thanks, changed here: 3a64a89

Co-authored-by: Agustin Bettati <[email protected]>

bodegus · 2025-08-26T12:27:48Z

docs/command_clu2adv.md

@@ -0,0 +1,194 @@
+# Convert mongodbatlas_cluster to mongodbatlas_advanced_cluster
+
+clusterToAdvancedCluster (clu2adv) command helps you migrate from `mongodbatlas_cluster` to `mongodbatlas_advanced_cluster` Provider 2.0.0 schema.


It could be helpful to clarify this. ++"This revised file migrates the terraform configurations and state to the latest version and does not modify the resources deployed in MongoDB Atlas"

thanks, changed here: 3ed0cde

docs/command_adv2v2.md

bodegus

LGTM

docs/command_adv2v2.md

docs/command_clu2adv.md

Co-authored-by: lmkerbey-mdb <[email protected]>

marcosuma · 2025-08-28T09:48:00Z

docs/command_adv2v2.md

+
+#### Combination of blocks with dynamic and inline expressions
+
+Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. Remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.


Suggested change

Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. Remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.

Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. To continue using this plugin, remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.

thanks, changed here: eddaa86

marcosuma · 2025-08-28T09:48:25Z

docs/command_adv2v2.md

+
+Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. Remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.
+
+Let's see an example with `region_configs`; it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.


Suggested change

Let's see an example with `region_configs`; it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.

##### Example

Let's see an example with `region_configs`; the same idea applies for `replication_specs`. In the original configuration file, the `mongodbatlas_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.

thanks, changed here: eddaa86

marcosuma · 2025-08-28T09:50:09Z

docs/command_clu2adv.md

+
+Dynamic blocks and individual blocks for `regions_config` or `replication_specs` are not supported at the same time. Remove the individual `regions_config` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.
+
+Let's see an example with `regions_config`, it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `regions_config` elements in a `list` variable and we want to add an additional `regions_config` with a read-only node.


you may apply the same suggestion I've given before, for consistency

thanks, changed here: eddaa86

Co-authored-by: lmkerbey-mdb <[email protected]>

initial doc

1459a03

lantoli changed the title ~~doc:~~ doc: Update doc for adv2v2 command Aug 25, 2025

lantoli added 7 commits August 25, 2025 15:52

remove guide_clu2adv_dynamic_block

da42d28

move info in file guide_adv2v2_dynamic_block.md to command_adv2v2.md

e27d5a4

update clu2adv doc

0ec0ed7

update adv2v2 doc

88653b0

typos

0c349b1

fix individual region

1a508f3

typo

2eb0958

lantoli marked this pull request as ready for review August 26, 2025 09:17

Copilot AI review requested due to automatic review settings August 26, 2025 09:17

lantoli requested a review from a team as a code owner August 26, 2025 09:17

Copilot AI reviewed Aug 26, 2025

View reviewed changes

docs/command_adv2v2.md Outdated Show resolved Hide resolved

lantoli requested a review from a team August 26, 2025 09:44

Update docs/command_adv2v2.md

52c69e8

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

EspenAlbert reviewed Aug 26, 2025

View reviewed changes

EspenAlbert approved these changes Aug 26, 2025

View reviewed changes

installation first

646a4e2

lantoli requested a review from bodegus August 26, 2025 10:45

AgustinBettati approved these changes Aug 26, 2025

View reviewed changes

lantoli and others added 2 commits August 26, 2025 13:05

Update docs/command_clu2adv.md

23593a5

Co-authored-by: Agustin Bettati <[email protected]>

change dynamic block section name

3a64a89

bodegus reviewed Aug 26, 2025

View reviewed changes

docs/command_adv2v2.md Outdated Show resolved Hide resolved

add doc clarification about underlaying resources not being changed

3ed0cde

bodegus approved these changes Aug 26, 2025

View reviewed changes

maastha approved these changes Aug 26, 2025

View reviewed changes

lmkerbey-mdb requested changes Aug 27, 2025

View reviewed changes

lantoli and others added 2 commits August 28, 2025 09:16

Update docs/command_adv2v2.md

e643483

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_adv2v2.md

ed10890

Co-authored-by: lmkerbey-mdb <[email protected]>

lantoli and others added 12 commits August 28, 2025 09:17

Update docs/command_adv2v2.md

a9eaa90

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

0c68989

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

b58b254

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

57f8832

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_adv2v2.md

64c0774

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

a6be82a

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

7fd7785

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_adv2v2.md

a6df286

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_adv2v2.md

f5f57f1

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_adv2v2.md

6c0a7cb

Co-authored-by: lmkerbey-mdb <[email protected]>

Update docs/command_clu2adv.md

2c6afef

Co-authored-by: lmkerbey-mdb <[email protected]>

apply feedback

3f5d2b2

marcosuma approved these changes Aug 28, 2025

View reviewed changes

lantoli and others added 3 commits August 28, 2025 12:22

apply more feedback

eddaa86

Update docs/command_adv2v2.md

2459d09

Co-authored-by: lmkerbey-mdb <[email protected]>

doc replaceOutput

45ce5d8

lmkerbey-mdb approved these changes Aug 29, 2025

View reviewed changes

lantoli merged commit 9cb43b4 into main Aug 29, 2025
7 checks passed

lantoli deleted the CLOUDP-340590_doc branch August 29, 2025 14:32


		If you need to use the plugin for `dynamic` block use cases not yet supported, please send us [feedback](https://github.com/mongodb-labs/atlas-cli-plugin-terraform/issues).

		#### Dynamic block and individual blocks in the same resource

		@@ -0,0 +1,194 @@
		# Convert mongodbatlas_cluster to mongodbatlas_advanced_cluster

		clusterToAdvancedCluster (clu2adv) command helps you migrate from `mongodbatlas_cluster` to `mongodbatlas_advanced_cluster` Provider 2.0.0 schema.


		#### Combination of blocks with dynamic and inline expressions

		Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. Remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.


		Dynamic blocks and individual blocks for `region_configs` or `replication_specs` are not supported at the same time. Remove the individual `region_configs` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.

		Let's see an example with `region_configs`; it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.

-Let's see an example with `region_configs`; it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.
+##### Example
+Let's see an example with `region_configs`; the same idea applies for `replication_specs`. In the original configuration file, the `mongodbatlas_cluster` resource is used inside a module that receives the `region_configs` elements in a `list` variable and we want to add an additional `region_configs` with a read-only node.


		Dynamic blocks and individual blocks for `regions_config` or `replication_specs` are not supported at the same time. Remove the individual `regions_config` or `replication_specs` blocks and use a local `list` variable with [concat](https://developer.hashicorp.com/terraform/language/functions/concat) to add the individual block information to the variable you're using in the `for_each` expression.

		Let's see an example with `regions_config`, it's the same idea for `replication_specs`. In the original configuration file, the `mongodb_cluster` resource is used inside a module that receives the `regions_config` elements in a `list` variable and we want to add an additional `regions_config` with a read-only node.

doc: Update doc for adv2v2 command #68

doc: Update doc for adv2v2 command #68

Uh oh!

Conversation

lantoli commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change:

Required Checklist:

Further comments

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lantoli Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AgustinBettati left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bodegus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lantoli commented Aug 25, 2025 •

edited

Loading

lantoli Aug 26, 2025 •

edited

Loading