Skip to content

doc: Adds remaining work to migrate_cluster_to_advanced_cluster examples #3065

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

Conversation

EspenAlbert
Copy link
Collaborator

@EspenAlbert EspenAlbert commented Feb 13, 2025

Description

Adds remaining work to migrate_cluster_to_advanced_cluster examples:

  • Add descriptions to all variables
  • Handle TODOs
  • Docs copywrite review

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

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

Variable descriptions (from advancedclustertpf/schema.go)

project_id: "Unique 24-hexadecimal digit string that identifies your project. Use the `/groups` at https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/listProjects endpoint to retrieve all projects to which the authenticated user has access.  **NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups"
cluster_name: "Human-readable label that identifies this cluster."
instance_size: 'Hardware specification for the instance sizes in this region in this shard. Each instance size has a default storage and memory capacity. Electable nodes and read-only nodes (known as "base nodes") within a single shard must use the same instance size. Analytics nodes can scale independently from base nodes within a shard. Both base nodes and analytics nodes can scale independently from their equivalents in other shards.'
mongo_db_major_version: "MongoDB major version of the cluster.  On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Projects/operation/getProjectLtsVersions.   On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version."
cluster_type: "Configuration of nodes that comprise the cluster."
provider_name: "Cloud service provider on which MongoDB Cloud provisions the hosts. Set dedicated clusters to `AWS`, `GCP`, `AZURE` or `TENANT`."
disk_size: "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.   This value must be equal for all shards and node types.   This value is not configurable on M0/M2/M5 clusters.   MongoDB Cloud requires this parameter if you set **replicationSpecs**.   If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value.    Storage charge calculations depend on whether you choose the default value or a custom value.   The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require more storage space, consider upgrading your cluster to a higher tier."
auto_scaling_disk_gb_enabled: "Flag that indicates whether this cluster enables disk auto-scaling. The maximum memory allowed for the selected cluster tier and the oplog size can limit storage auto-scaling."
tags: "Map that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster."
replication_specs: "List of replication specifications in mongodbatlas_cluster format"
replication_specs_new: "List of replication specifications using new mongodbatlas_advanced_cluster format"
public_key: Public API key to authenticate to Atlas
private_key: Private API key to authenticate to Atlas

Output descriptions

mongodb_connection_strings: "Collection of Uniform Resource Locators that point to the MongoDB database."
connection_string_standard: "Public connection string that you can use to connect to this cluster. This connection string uses the `mongodb://` protocol."
container_id: "The Network Peering Container ID of the configuration specified in `region_configs`. The Container ID is the id of the container either created programmatically by the user before any clusters existed in a project or when the first cluster in the region (AWS/Azure) or project (GCP) was created. Example `AWS:US_EAST_1\" = \"61e0797dde08fb498ca11a71`"
cluster_name: MongoDB Atlas cluster name
project_id: MongoDB Atlas project id

@EspenAlbert EspenAlbert marked this pull request as ready for review February 13, 2025 17:25
@EspenAlbert EspenAlbert requested a review from a team as a code owner February 13, 2025 17:25
@EspenAlbert
Copy link
Collaborator Author

Handy links to see all readme files:

  1. module user
  2. module maintainer
  3. basic

Copy link
Member

@lantoli lantoli left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@lantoli lantoli left a comment

Choose a reason for hiding this comment

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

well seen

@lantoli
Copy link
Member

lantoli commented Feb 14, 2025

@EspenAlbert note that it happens in multiple files

set

@EspenAlbert
Copy link
Collaborator Author

@EspenAlbert note that it happens in multiple files

set

Did you pull?

@lantoli
Copy link
Member

lantoli commented Feb 14, 2025

@EspenAlbert i didn't, so my files can be outdated

@EspenAlbert
Copy link
Collaborator Author

Merging, hoping for docs review on the merge to master

@EspenAlbert EspenAlbert merged commit fb99be0 into CLOUDP-274025-dev-docs-examples Feb 17, 2025
40 checks passed
@EspenAlbert EspenAlbert deleted the CLOUDP-299314_modules_final_touches branch February 17, 2025 08:06
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants