Skip to content
This repository was archived by the owner on Oct 4, 2024. It is now read-only.

Doc edits #41

Merged
merged 5 commits into from
Mar 16, 2023
Merged

Doc edits #41

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e77f045
added info on setting up profile
poornatejakonathampi Mar 14, 2023
75087a2
Update docs/deployment_guide/partner_editable/pre_deployment.adoc
vsnyc Mar 16, 2023
109f9f5
Merge pull request #40 from SuperMohit/doc-edits
vsnyc Mar 16, 2023
c28608b
Update docs/deployment_guide/partner_editable/pre_deployment.adoc
vsnyc Mar 16, 2023
499fdc7
Update docs/deployment_guide/partner_editable/pre_deployment.adoc
vsnyc Mar 16, 2023
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/deployment_guide/partner_editable/pre_deployment.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ This Partner Solution uses MongoDB Atlas CloudFormation resource types and autom
=== Prepare your {partner-company-name} account

A MongoDB Atlas programmatic API key must be generated with the appropriate permissions and network access entries so that AWS CloudFormation can successfully authenticate the MongoDB cloud. For more information about creating and managing API keys, see https://docs.atlas.mongodb.com/tutorial/manage-programmatic-access[Programmatic Access to Atlas^].

After creating the programmatic API key, it needs to be stored as a secret in AWS Secrets Manager with the following naming convention `cfn/atlas/profile/${ProfileName}`. Use https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/examples/profile-secret.yaml[this^] CloudFormation template to create the secret in the AWS Region where this Partner Solution is going to be deployed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Reword slightly to: After creating the programmatic API key, store it as a secret in AWS Secrets Manager with the following naming convention: cfn/atlas/profile/${ProfileName}. Use this https://github.com/mongodb/mongodbatlas-cloudformation-resources/blob/master/examples/profile-secret.yaml[CloudFormation template^] to create the secret in the AWS Region where this Partner Solution will be deployed.