Skip to content

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

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.

Sign up for GitHub

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

Closed
jromo-mdb wants to merge 4 commits into from
Closed

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9396430
(DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft
jromo-mdb Sep 12, 2025
4d86685
Fix copilot suggestions about typos
jromo-mdb Sep 12, 2025
888cf32
Add note about unavailable upgrades and API reference link in attribu…
jromo-mdb Sep 12, 2025
8e406c0
Address feedback on documentation section.
jromo-mdb Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions cfn-resources/flex-cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,21 @@

## Description

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

@lantoli lantoli Sep 12, 2025

Choose a reason for hiding this comment

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

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

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.
Copy link

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

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

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 uses AI. Check for mistakes.

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

## Requirements

Set up an AWS profile to securely give CloudFormation access to your Atlas credentials.
For instructions on setting up a profile, [see here](/README.md#mongodb-atlas-api-keys-credential-management).
To securely give CloudFormation access to your Atlas credentials, you must
set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management).

## Attributes and Parameters

See the [resource docs](docs/README.md).

## Cloudformation Examples

See the examples [CFN Template](/examples/flex-cluster/flex-cluster.json) for example resource.
See the examples [CFN Template](/examples/flex-cluster/README.md) for example resource.
18 changes: 18 additions & 0 deletions examples/flex-cluster/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# How to create a MongoDB::Atlas::FlexCluster

## 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.
Copy link

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

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

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 uses AI. Check for mistakes.

(Cloudformation > Public extensions > choose 'Third party' > Search with " Execution name prefix = MongoDB " )
Step c: Select and activate
Enter the RoleArn that is created in step 1.

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 values for:
1. OrgId
2. ProjectName
3. Clustername
Copy link

Copilot AI Sep 12, 2025

Choose a reason for hiding this comment

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

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

Suggested change
3. Clustername
3. ClusterName

Copilot uses AI. Check for mistakes.
Loading