Notice: Repository Deprecation

This repository is deprecated and no longer actively maintained. It contains outdated code examples or practices that do not align with current MongoDB best practices. While the repository remains accessible for reference purposes, we strongly discourage its use in production environments. Users should be aware that this repository will not receive any further updates, bug fixes, or security patches. This code may expose you to security vulnerabilities, compatibility issues with current MongoDB versions, and potential performance problems. Any implementation based on this repository is at the user's own risk. For up-to-date resources, please refer to the MongoDB Developer Center.

Get-Started AWS CloudFormation

Repository to help getting started with using MongoDB Atlas with AWS CloudFormation (CFN).

Information

This Get-Started project provides a quick and simple way to use the MongoDB Atlas on AWS Quick Start which uses the MongoDB Atlas CloudFormation resources to provision a complete MongoDB Atlas deployment. This includes:

• 1 MongoDB Atlas project
• 1 MongoDB Atlas M10 cluster
• 1 AWS IAM role
• 1 MongoDB Atlas database user (Type: AWS IAM role)
• 1 MongoDB Atlas project IP Access List entry

The outputs include an AWS Lambda-ready IAM role and connection string to your MongoDB Atlas cluster.

NOTE Running this project will incur charges on AWS and MongoDB Atlas.

Pre-requisites

AWS Tooling

In order to use this Get-Started project, you need to install the AWS CLI on your machine. You can download and install from https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html

You will also need an AWS account with appropriate CloudFormation and IAM permissions. Please see the section AWS IAM Permissions for details.

Docker

You will need to have Docker running on your machine. You can download and install Docker from https://docs.docker.com/install/

mongocli

The best way to manage your MongoDB Atlas API Keys today is via the mongocli. This project can leverage your mongocli configuration.

MongoDB Atlas

In order to execute the code example, you need to:

• Sign up for a MongoDB Atlas account
• Skip the cluster deployment options
• Go to Billing and add a credit card to your account
• Create an organization-level MongoDB Atlas Programmatic API Key with an IP Access List entry. The key needs Organization Project Creator permissions.

Once created, run mongocli config and enter the Atlas private API key you just created, along with your Atlas public API key and organization ID.

Execution Steps

Deploy MongoDB Atlas CFN Resources into your AWS Region

get-setup.sh

1. Execute the helper shell setup script to complete this step. This will package and deploy the MongoDB Atlas CloudFormation resources into your current default AWS region:

./get-setup.sh 

You can optionally pass in the AWS region or change your local AWS CLI configuration.

./get-setup.sh us-west-2

or

aws configure set region eu-west-3
./get-setup.sh

Note this step can take up to 45 minutes to run. Run this step once in each region you wish to use.

Once complete, you will find a set of CFN Stacks for the MongoDB Atlas resources.

get-started.sh

2. Execute the helper shell starter script, optionally providing a MongoDB Atlas project name. The output from get-setup.sh helper script will inform you of the details for your new MongoDB Atlas deployment, including AWS IAM role and cluster connection string information for you applications. Note this step typically takes 7-10 minutes.

If you have installed mongocli, run:

./get-started.sh <GETSTARTED_NAME> 

Or you can explicitly set the API key or get prompted:

./get-started.sh <PUBLIC_KEY> <PRIVATE_KEY> <ORG_ID> <GETSTARTED_NAME> 

Once successful, you should be able to access your new deployment through the AWS console, AWS CLI, MongoDB Atlas console, or mongocli.

Connecting to your cluster

You can see the connection information in the AWS CloudFormation stack output.

GETSTARTED_NAME="get-started-aws-quickstart"
MDB=$(aws cloudformation list-exports | \
 jq -r --arg stackname "${GETSTARTED_NAME}" \
 '.Exports[] | select(.Name==$stackname+"-ClusterSrvAddress") | .Value')
echo "Found stack:${GETSTARTED_NAME} with ClusterSrvAddress: ${MDB}"

Note This example requires the jq tool. See https://stedolan.github.io/jq/download/.

Testing AWS IAM connection

There is a helper script test-iam-mongo-connection.sh available to script passing AWS IAM session credentials into the mongo shell. To use this, pass the STACK_NAME as a parameter:

./test-iam-mongo-connection.sh NewRoleBased-1
Found stack:NewRoleBased-1 with ClusterSrvAddress: mongodb+srv://cluster-1.5hmwe.mongodb.net
STACK_ROLE={
    "StackResources": [
        {
            "StackName": "NewRoleBased-1",
...
MongoDB shell version v4.4.1
connecting to: mongodb://cluster-1-shard-00-00.5hmwe.mongodb.net:27017,cluster-1-shard-00-01.5hmwe.mongodb.net:27017,cluster-1-shard-00-02.5hmwe.mongodb.net:27017/admin?authMechanism=MONGODB-AWS&authmechanismproperties=AWS_SESSION_TOKEN%3AIQoJb3JpZ2luX2VjEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQDQ4mV7RtfYCLrQwBg
...
PRIMARY>

Tear Down

To remove the environment setup (deleting traces of this get-started project):

• Delete the Quick Start stack from the AWS console or CLI, or by using this helper script:

  ./teardown.sh <GETSTARTED_NAME>
  

• Terminate the get-started.sh process if it's running. This is to stop the web service on localhost:3000.

• Delete the AWS CloudFormation stack created, by default this will have the :

  aws cloudformation delete-stack --stack-name <Quick Start-Name>
  

• Remove the Docker volumes

• Remove the Docker image

About

This project is part of the MongoDB Get-Started code examples. Please see get-started-readme for more information.

Developer Notes

Not required unless needing to refesh with latest resource source code. This will build a fresh image of the resources for stable distribution.

Build Docker image with a tag name. Within the top level directory execute:

docker build . -t mongodb-developer/get-started-aws-cfn

This will build a docker image with a tag name get-started-aws-cfn.

NOTE Currently the source repositories are private which will prevent a clean build without proper Github ssh access. A pre-build image has been upload for convience until these repos become public: mongodb-developer/get-started-aws-cfn.

To build the container - need this:

export DOCKER_BUILDKIT=1
docker build --ssh github=$HOME/.ssh/id_rsa -t atlas-aws .

This docker image is currently built internally and published to:

public.ecr.aws/u1r4t8v5/mongodb-developer/get-started-aws-cfn:latest

Troubleshoot

Check access to Docker image

Try this command to check if you can access the Docker image required for this project.

docker run -it public.ecr.aws/u1r4t8v5/mongodb-developer/get-started-aws-cfn "head -1 /quickstart-mongodb-atlas-resources/README.md"
# MongoDB Atlas AWS CloudFormation Resources & Quickstart

AWS IAM permissions

This project requires various kinds of AWS permissions.

To run the setup step ([get-setup.sh](./get-setup.sh)) AWS team account owners should be able to assume the policy-quickstart-mongodb-atlas-installer.yaml sample permission set. This step requires above average permissions.

For the started step ([get-started.sh](./get-started.sh)) AWS users should be able to assume the policy-quickstart-mongodb-atlas-user.yaml sample permission set.

We've included a sample minimal example set of policies, which you can assume safely and use with this project.

Create new AWS IAM roles with the supplied policies. Below are examples on how to do that via AWS CloudFormation. You can then assume the role with aws sts assume-role. We recommend this for exporting your AWS environment into the Docker environment to run this project (note the --role-arn used in step 2 is created in the step 1).

AWS::IAM::Role MongoDB-Atlas-CloudFormation-Installer

aws cloudformation create-stack \
  --capabilities CAPABILITY_NAMED_IAM \
  --template-body file://./policy-quickstart-mongodb-atlas-installer.yaml \
  --stack-name quickstart-mongodb-atlas-installer-role

source <(aws sts assume-role --role-arn arn:aws:iam::<YOUR_AWS_ACCOUNT>:role/MongoDB-Atlas-CloudFormation-Installer --role-session-name "get-started-installer"  | jq -r  '.Credentials | @sh "export AWS_SESSION_TOKEN=\(.SessionToken)\nexport AWS_ACCESS_KEY_ID=\(.AccessKeyId)\nexport AWS_SECRET_ACCESS_KEY=\(.SecretAccessKey) "')

AWS::IAM::Role MongoDB-Atlas-CloudFormation-User

aws cloudformation create-stack \
  --capabilities CAPABILITY_NAMED_IAM \
  --template-body file://./policy-quickstart-mongodb-atlas-user.yaml \
  --stack-name quickstart-mongodb-atlas-user-role

source <(aws sts assume-role --role-arn arn:aws:iam::<YOUR_AWS_ACCOUNT>:role/MongoDB-Atlas-CloudFormation-User --role-session-name "get-started-user"  | jq -r  '.Credentials | @sh "export AWS_SESSION_TOKEN=\(.SessionToken)\nexport AWS_ACCESS_KEY_ID=\(.AccessKeyId)\nexport AWS_SECRET_ACCESS_KEY=\(.SecretAccessKey) "')

Remember to UNSET your AWS_* environment variables to "un-assume" the role.

source <(env | awk -F= '/AWS/ {print "unset ", $1}'

(Reference: get-token.md)

^{[1] Access coming soon: [AWS Quick Start for MongoDB Atlas](https://github.com/aws-quickstart/quickstart-mongodb-atlas) [2] Access coming soon: [MongoDB Atlas CloudFormation resources](https://github.com/aws-quickstart/quickstart-mongodb-atlas-resources)}