From 9396430613d8ba565d33c4877d497759c7dc1c0d Mon Sep 17 00:00:00 2001 From: Joaquin Alonso Romo Espejel Date: Fri, 12 Sep 2025 09:51:19 -0600 Subject: [PATCH 1/4] (DOCSP-53418) MongoDB::Atlas::FlexCluster README initial draft --- cfn-resources/flex-cluster/README.md | 10 ++++++---- examples/flex-cluster/README.md | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 examples/flex-cluster/README.md diff --git a/cfn-resources/flex-cluster/README.md b/cfn-resources/flex-cluster/README.md index b8bbe49e2..a8541211e 100644 --- a/cfn-resources/flex-cluster/README.md +++ b/cfn-resources/flex-cluster/README.md @@ -2,12 +2,14 @@ ## Description -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). ## 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 @@ -15,4 +17,4 @@ 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. diff --git a/examples/flex-cluster/README.md b/examples/flex-cluster/README.md new file mode 100644 index 000000000..e3d528e63 --- /dev/null +++ b/examples/flex-cluster/README.md @@ -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. + + (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 vales for + 1. OrgId + 2. ProjectName + 3. Clustername \ No newline at end of file From 4d866856f335d200a2f52e814fc978af36639e7a Mon Sep 17 00:00:00 2001 From: Joaquin Alonso Romo Espejel Date: Fri, 12 Sep 2025 09:54:57 -0600 Subject: [PATCH 2/4] Fix copilot suggestions about typos --- cfn-resources/flex-cluster/README.md | 2 +- examples/flex-cluster/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cfn-resources/flex-cluster/README.md b/cfn-resources/flex-cluster/README.md index a8541211e..871e4ceaa 100644 --- a/cfn-resources/flex-cluster/README.md +++ b/cfn-resources/flex-cluster/README.md @@ -4,7 +4,7 @@ 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). +*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 diff --git a/examples/flex-cluster/README.md b/examples/flex-cluster/README.md index e3d528e63..8ac8988ce 100644 --- a/examples/flex-cluster/README.md +++ b/examples/flex-cluster/README.md @@ -12,7 +12,7 @@ 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 + Note: Make sure you are providing appropriate values for: 1. OrgId 2. ProjectName 3. Clustername \ No newline at end of file From 888cf32bf176000d6107435706bbd69b61b62833 Mon Sep 17 00:00:00 2001 From: Joaquin Alonso Romo Espejel Date: Fri, 12 Sep 2025 10:06:29 -0600 Subject: [PATCH 3/4] Add note about unavailable upgrades and API reference link in attributes and parameters section. --- cfn-resources/flex-cluster/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/cfn-resources/flex-cluster/README.md b/cfn-resources/flex-cluster/README.md index 871e4ceaa..e7dd4e503 100644 --- a/cfn-resources/flex-cluster/README.md +++ b/cfn-resources/flex-cluster/README.md @@ -4,6 +4,8 @@ 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. + *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 @@ -13,7 +15,7 @@ set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management) ## 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). ## Cloudformation Examples From 8e406c0af67e0fa315c98babdad313ac68fe1d29 Mon Sep 17 00:00:00 2001 From: Joaquin Alonso Romo Espejel Date: Fri, 12 Sep 2025 10:25:25 -0600 Subject: [PATCH 4/4] Address feedback on documentation section. --- cfn-resources/flex-cluster/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cfn-resources/flex-cluster/README.md b/cfn-resources/flex-cluster/README.md index e7dd4e503..2f5ca19c6 100644 --- a/cfn-resources/flex-cluster/README.md +++ b/cfn-resources/flex-cluster/README.md @@ -15,7 +15,7 @@ set up an [AWS Profile](/README.md#mongodb-atlas-api-keys-credential-management) ## Attributes and Parameters -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). +See the [resource docs](docs/README.md). ## Cloudformation Examples