Skip to content

Commit 673b233

Browse files
doc: Enhances README with additional MongoDB Atlas and AWS CloudFormation documentation links and resource support details (#1313)
Co-authored-by: Marco Suma <[email protected]>
1 parent e5cfb6c commit 673b233

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# MongoDB Atlas AWS CloudFormation Resources & AWS Partner Solution Deployments
1+
# MongoDB Atlas AWS CloudFormation Resources
22
[![Code Health](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/code-health.yaml/badge.svg?branch=master)](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/code-health.yaml)
33
[![Contract Testing](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/contract-testing.yaml/badge.svg?branch=master)](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/contract-testing.yaml)
44

5-
Use AWS CloudFormation to manage [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
6-
7-
Partner Solutions (formally AWS Quick Starts) are automated reference deployments built by Amazon Web Services (AWS) solutions architects and AWS Partners. Partner Solutions help you deploy popular technologies to AWS according to AWS best practices. The quickest way to get started is to launch the official [MongoDB Atlas on AWS](https://aws.amazon.com/quickstart/architecture/mongodb-atlas/) Partner Solution Deployment directly from the AWS Management Console.
5+
Use [AWS CloudFormation](https://aws.amazon.com/cloudformation/) to manage [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). See our [documentation](https://www.mongodb.com/products/integrations/aws-cloudformation) for quick starts and common questions. For a list of supported resources, see [here](cfn-resources/README.md).
86

97
## Getting Started
108
### MongoDB Atlas CloudFormation
11-
See the [`cfn` examples](examples/README.md) to setup prerequisites and get started with your first cluster using our sample CloudFormation Stack templates.
9+
10+
See the [`cfn` examples](examples/README.md) to setup prerequisites and get started with your first cluster using our sample CloudFormation Stack templates. Follow the steps in [Activate the MongoDB Atlas CloudFormation public extensions](examples/README.md#activate-the-mongodb-atlas-cloudformation-public-extensions) for each AWS Account and Region where you want to deploy your MongoDB Atlas resources.
1211

1312
### MongoDB Atlas AWS CDK
1413
See the [cdk examples](https://github.com/mongodb/awscdk-resources-mongodbatlas/blob/main/examples/README.md) to setup prerequisites and get started with your first cluster using our AWS CDK sample code.
@@ -27,7 +26,11 @@ CloudFormation import is supported for MongoDB Atlas resources. This allows you
2726
## Support, Bugs, Feature Requests
2827
Feature requests can be submitted at [feedback.mongodb.com](https://feedback.mongodb.com/forums/924145-atlas/category/392596-atlas-cloudformation-resources) - just select "Atlas CloudFormation Resources" as the category or vote for an already suggested feature.
2928

30-
Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions within the Atlas UI. In addition, support questions submitted under the Issues section of this repo are also being monitored. Bugs should be filed under the Issues section of this repo.
29+
Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions via the [Support Portal](https://support.mongodb.com/). Support questions submitted under the Issues section of this repo are monitored but have no SLA and are best effort. Bugs should be filed under the Issues section of this repo.
30+
31+
**Please note**:
32+
- In order to ensure the highest quality experience and support, we only support resources published via the [AWS Cloudformation Third Party registry](https://console.aws.amazon.com/cloudformation/home#/registry/public-extensions?visibility=PUBLIC&type=RESOURCE&category=THIRD_PARTY) (select "Third party" as `Provider` and search by "MongoDB::Atlas"). Any usage outside of this workflow is not supported or recommended.
33+
* New features, functionality, and fix bugs are only included in the latest release. Hence, we strongly encourage all users to always update to the latest version to benefit from these improvements. See the [Upgrade the MongoDB Atlas CloudFormation public extensions](examples/README.md#upgrade-the-mongodb-atlas-cloudformation-public-extensions) for how to upgrade.
3134

3235
## MongoDB Atlas API Keys Credential Management
3336
Atlas API keys Configuration are required for both CloudFormation and CDK resources, and this Atlas API key pair are provided as input by the use of a Profile

examples/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ The recommended options include:
132132
```
133133
- replace `{KEY_ARN}` with your kms key arn
134134

135+
## Upgrade the MongoDB Atlas CloudFormation public extensions
136+
To upgrade an existing `MongoDB::Atlas` resource type you need to: (see [Activate the MongoDB Atlas CloudFormation public extensions](#activate-the-mongodb-atlas-cloudformation-public-extensions) to activate a new resource type):
137+
138+
1. Navigate to the [Cloudformation -> Registry -> Activated extensions](https://eu-north-1.console.aws.amazon.com/cloudformation/home?region=eu-north-1#/registry/activated-extensions/resource-types?category=ACTIVATED&type=RESOURCE).
139+
2. Select the resource type you want to update.
140+
3. Click Actions -> Update (if you enabled Automatic Updates when activating the resource type, any minor, for example `1.0.0` to `1.1.0` will be automaticlly updated).
141+
4. Re run the [stacks](https://eu-north-1.console.aws.amazon.com/cloudformation/home?region=eu-north-1#/stacks?filteringText=&filteringStatus=active&viewNested=true) using the upgraded resource type.
142+
135143
## Using the examples
136144
Once your prerequisites are configured, use the examples in this folder as a starting template for a resource to quickly create a CloudFormation stack.
137145

0 commit comments

Comments
 (0)