(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft by jromo-mdb · Pull Request #1440 · mongodb/mongodbatlas-cloudformation-resources

jromo-mdb · 2025-09-12T15:51:39Z

Proposed changes

Jira ticket: CLOUDP-#

Please include a summary of the fix/feature/change, including any relevant motivation and context.

Link to any related issue(s):

Type of change:

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as
expected)
This change requires a documentation update
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.

Manual QA performed:

cfn invoke for each of CRUDL/cfn test
Updated resource in example
Published to AWS private registry
Used the template in example to create and update a stack in AWS
Deleted stack to ensure resources are deleted
Created multiple resources in same stack
Validated in Atlas UI
Included screenshots

Required Checklist:

I have signed the MongoDB CLA
I have added tests that prove my fix is effective or that my feature works
I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
I have added any necessary documentation (if appropriate)
I have run make fmt and formatted my code
For CFN Resources: I have released by changes in the private registry and proved by change
works in Atlas

Further comments

github-actions · 2025-09-12T15:51:49Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details: CONTRIBUTING.md

No release type found in pull request title "(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat
 - fix
 - chore
 - doc
 - test
 - security
 - remove
 - deprecate
 - refactor
 - perf
 - ci
 - revert
 - style

Copilot

Pull Request Overview

This PR adds initial documentation for the MongoDB::Atlas::FlexCluster CloudFormation resource, including setup instructions and important deprecation notices.

Creates a new README for the flex-cluster example with step-by-step activation and template creation instructions
Updates the flex-cluster resource README with improved description, deprecation warning, and corrected links

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
examples/flex-cluster/README.md	New documentation providing activation steps and template usage guidance
cfn-resources/flex-cluster/README.md	Enhanced description with deprecation notice and updated example link

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

Copilot · 2025-09-12T15:52:03Z

+   Your FlexCluster Resource is ready to use.
+
+## Step 2: Create template using [flex-cluster.json](flex-cluster.json)
+    Note: Make sure you are providing appropriate vales for 


Typo in 'vales' should be 'values'.

Suggested change

Note: Make sure you are providing appropriate vales for

Note: Make sure you are providing appropriate values for

Copilot · 2025-09-12T15:52:03Z

-Resource for managing [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).
+The flex cluster resource provides access to your [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters) configurations and enables you to create, edit, and delete flex clusters. For more information, see [The MongoDB Atlas Flex Tier](https://www.mongodb.com/company/blog/product-release-announcements/dynamic-workloads-predictable-costs-mongodb-atlas-flex-tier).
+
+*Important:* Use the `MongoDB::Atlas::Cluster` resource instead of the ``MongoDB::Atlas::FlexCluster`` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).


Inconsistent backtick formatting around 'MongoDB::Atlas::FlexCluster'. It uses double backticks (``) while other resource names use single backticks (`).

Suggested change

*Important:* Use the `MongoDB::Atlas::Cluster` resource instead of the ``MongoDB::Atlas::FlexCluster`` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).

*Important:* Use the `MongoDB::Atlas::Cluster` resource instead of the `MongoDB::Atlas::FlexCluster` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).

…tes and parameters section.

lantoli · 2025-09-12T16:14:37Z

 ## Attributes and Parameters

-See the [resource docs](docs/README.md).
+See the [resource docs](docs/README.md) and the [Flex Clusters API reference](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).


I wouldn't change this sentence as CfnFlexCluster has different attributes to CfnCluster and this can confuse customers into believe that they need to use the CfnFlexCluster attribute format in their CfnCluster resources.

lantoli · 2025-09-12T16:16:25Z


 ## Description

-Resource for managing [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).


please use a branch in the repo instead of your personal GH org

Copilot

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

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

Copilot · 2025-09-12T16:26:08Z

-Resource for managing [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).
+The flex cluster resource provides access to your [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters) configurations and enables you to create, edit, and delete flex clusters. For more information, see [The MongoDB Atlas Flex Tier](https://www.mongodb.com/company/blog/product-release-announcements/dynamic-workloads-predictable-costs-mongodb-atlas-flex-tier).
+
+*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the forseeable future.


Spelling error: 'forseeable' should be 'foreseeable'.

Suggested change

*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the forseeable future.

*Note:* Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the foreseeable future.

Copilot · 2025-09-12T16:26:09Z

+## Step 1: Activate the cluster resource in cloudformation
+   Step a: Create Role using [execution-role.yaml](https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/examples/execution-role.yaml) in CFN resources folder.
+
+   Step b: Search for Mongodb::Atlas::FlexCluster resource.


Inconsistent capitalization: 'Mongodb' should be 'MongoDB' to match the standard formatting used elsewhere in the documentation.

Suggested change

Step b: Search for Mongodb::Atlas::FlexCluster resource.

Step b: Search for MongoDB::Atlas::FlexCluster resource.

Copilot · 2025-09-12T16:26:09Z

+    Note: Make sure you are providing appropriate values for: 
+    1. OrgId
+    2. ProjectName
+    3. Clustername


[nitpick] Consider using 'ClusterName' or 'Cluster Name' for consistency with typical naming conventions.

Suggested change

3. Clustername

3. ClusterName

jromo-mdb · 2025-09-12T16:42:10Z

Duplicated by #1441

(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft

9396430

Copilot AI review requested due to automatic review settings September 12, 2025 15:51

jromo-mdb requested a review from a team as a code owner September 12, 2025 15:51

Copilot AI reviewed Sep 12, 2025

View reviewed changes

jromo-mdb added 2 commits September 12, 2025 09:54

Fix copilot suggestions about typos

4d86685

Add note about unavailable upgrades and API reference link in attribu…

888cf32

…tes and parameters section.

lantoli reviewed Sep 12, 2025

View reviewed changes

Address feedback on documentation section.

8e406c0

jromo-mdb requested a review from Copilot September 12, 2025 16:25

Copilot AI reviewed Sep 12, 2025

View reviewed changes

jromo-mdb closed this Sep 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft#1440

(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft#1440
jromo-mdb wants to merge 4 commits intomongodb:masterfrom
jromo-mdb:DOCSP-53418

jromo-mdb commented Sep 12, 2025

Uh oh!

github-actions Bot commented Sep 12, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 12, 2025

Uh oh!

Copilot AI Sep 12, 2025

Uh oh!

lantoli Sep 12, 2025

Uh oh!

lantoli Sep 12, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 12, 2025

Uh oh!

Copilot AI Sep 12, 2025

Uh oh!

Copilot AI Sep 12, 2025

Uh oh!

jromo-mdb commented Sep 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	Note: Make sure you are providing appropriate vales for
	Note: Make sure you are providing appropriate values for

	Important: Use the `MongoDB::Atlas::Cluster` resource instead of the ``MongoDB::Atlas::FlexCluster`` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).
	Important: Use the `MongoDB::Atlas::Cluster` resource instead of the `MongoDB::Atlas::FlexCluster` resource to create and manage flex clusters. `MongoDB::Atlas::Cluster` supports flex clusters and future upgrades will only be available through this resource. For more information, see [`MongoDB::Atlas::Cluster` README](../cluster/README.md).


		## Description

		Resource for managing [Flex Clusters](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-flex-clusters).

	Note: Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the forseeable future.
	Note: Upgrades to or from flex clusters are currently unavailable. We expect to support upgrades to or from flex clusters in the foreseeable future.

	Step b: Search for Mongodb::Atlas::FlexCluster resource.
	Step b: Search for MongoDB::Atlas::FlexCluster resource.

Conversation

jromo-mdb commented Sep 12, 2025

Proposed changes

Type of change:

Manual QA performed:

Required Checklist:

Further comments

Uh oh!

github-actions Bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

lantoli Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

lantoli Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

Uh oh!

jromo-mdb commented Sep 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Sep 12, 2025 •

edited

Loading