Skip to content

Commit a147282

Browse files
committed
doc: Add upgrade instructions for MongoDB Atlas CloudFormation public extensions
1 parent a86cd5d commit a147282

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Feature requests can be submitted at [feedback.mongodb.com](https://feedback.mon
2929
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.
3030

3131
**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.
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.
3434

3535
## MongoDB Atlas API Keys Credential Management
3636
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)