How to deploy the MongoDB Atlas Boilerplate

This template helps you to deploy an application integrated with MongoDB Atlas on Azion and manage it via API.

Last updated

View as Markdown Agent setup

The MongoDB Atlas Boilerplate allows you to deploy an application integrated with MongoDB Atlas on Azion. Besides, due to the integration with the Atlas Data API, you’re able to create, retrieve, update, and delete items in your collections through standard HTTPS requests.

By using Azion Web Platform to run your database project, your digital data and assets benefit from edge computing capabilities, including faster delivery, lower latency, and enhanced security.

Requirements

Before using this template, you need to:

Any cost generated by MongoDB usage will be processed and billed separately on the MongoDB platform. Visit the MongoDB Atlas documentation for more details.

Deploying the template

You can obtain and configure your template through the Azion Console. To easily deploy it on Azion, select the button below.

Deploy

Setting up the template

In the configuration form, you must provide the information to configure your application. Fill in the presented fields.

Fields identified with an asterisk are mandatory.

Connect Azion with your GitHub account
  • A pop-up window will open to confirm the installation of the Azion GitHub App, a tool that connects your GitHub account with Azion’s platform.
  • Define your permissions and repository access as desired.
Select the Git Scope

Select the Git Scope to work with.

Fill in the fields
  • Application Name *: the name of your application on Azion.
    • The bucket for storage and the function will use the same name.
    • Use a unique and easy-to-remember name. If the name has already been used, the platform returns an error message.
  • Atlas API Token *: the token to authorize the connection with the Atlas Data API.
  • Atlas API URL *: the assigned URL endpoint to connect with Atlas Data API.
  • Collection Name *: the name of a created collection in the specified database.
  • Database Name *: the name of the created database in the MongoDB Atlas data source.
  • dataSource Name *: the name of the created MongoDB Atlas data source or cluster.
Select Deploy

Select the Deploy button to start the deployment process.

During the deployment, you’ll be able to follow the process through a window showing the logs. When it’s complete, the page shows information about the application and some options to continue your journey.

The link to the application allows you to see it on the browser. However, it takes a certain time to propagate and configure the application on Azion’s distributed infrastructure. It may be necessary to wait a few minutes for the URL to be activated and for the application page to be effectively displayed in the browser.

Key configurations

By deploying this template, the script creates:

  • An application to run your project and manage all your settings.
  • An Azion Workload domain to access your application. You can also set up a custom domain to run on this application.
  • A function containing custom logic.
  • A GitHub repository for your project. The repository includes a GitHub Action that guarantees a continuous deployment workflow.

The execution of this template also includes integration with MongoDB Atlas and Atlas Data API, acting as a middleware to manage and access your database.

HTTPS requests examples

The integration with the Atlas Data API enables you to access the data using standard HTTPS requests. Acting as a middleware to access and manage your data, the API sits between your cluster and the client requests.

You’re able to create, retrieve, update, and delete items in your collections through any tools that allow you to send standard HTTPS requests, such as your terminal or Postman.

The API has dedicated endpoints according to the operation you want to complete.

Finding a document

Shell
01curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/findOne" \
02 -X POST \
03 -H "apiKey: $API_KEY" \
04 -H 'Content-Type: application/ejson' \
05 -H "Accept: application/json" \
06 -d {
07 "dataSource": "my-datasource",
08 "database": "my-database-azion",
09 "collection": "template",
10 "filter": {
11 "text": "Do the dishes"
12 }
13 }

Where:

VariableRequiredTypeDescription
dataSourceYesStringThe name of your data source or cluster
databaseYesStringThe name of the database in the data source
collectionYesStringThe name of a created collection in the specified database
filterYesObjectA query operator to filter the documents

Inserting a document

Shell
01curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/insertOne" \
02 -X POST \
03 -H "apiKey: $API_KEY" \
04 -H 'Content-Type: application/ejson' \
05 -H "Accept: application/json" \
06 -d {
07 "dataSource": "my-datasource",
08 "database": "my-database-azion",
09 "collection": "template",
10 "document": {
11 "status": "open",
12 "text": "Do the dishes"
13 }
14 }

Where:

VariableRequiredTypeDescription
dataSourceYesStringThe name of your data source or cluster
databaseYesStringThe name of the database in the data source
collectionYesStringThe name of a created collection in the specified database
documentYesObjectThe document to insert into the collection

Updating a document

Shell
01curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/updateOne" \
02 -X POST \
03 -H "apiKey: $API_KEY" \
04 -H 'Content-Type: application/ejson' \
05 -H "Accept: application/json" \
06 -d {
07 "dataSource": "my-datasource",
08 "database": "my-database-azion",
09 "collection": "template",
10 "filter": {
11 "_id": { "$oid": "64224f4d089104f1766116a5" }
12 },
13 "update": {
14 "$set": {
15 "status": "complete",
16 "completedAt": { "$date": { "$numberLong": "1680105272788" } }
17 }
18 }
19 }

Where:

VariableRequiredTypeDescription
dataSourceYesStringThe name of your data source or cluster
databaseYesStringThe name of the database in the data source
collectionYesStringThe name of a created collection in the specified database
filterYesObjectA query operator to filter the documents
updateYesObjectAn update expression to apply to matching documents

Deleting a document

Shell
01curl -s "https://data.mongodb-api.com/app/$CLIENT_APP_ID/endpoint/data/v1/action/deleteOne" \
02 -X POST \
03 -H "apiKey: $API_KEY" \
04 -H 'Content-Type: application/ejson' \
05 -H "Accept: application/json" \
06 -d {
07 "dataSource": "my-datasource",
08 "database": "my-database-azion",
09 "collection": "template",
10 "filter": {
11 "_id": { "$oid": "64224f3cd79f54ad342dd9b2" }
12 }
13 }

Where:

VariableRequiredTypeDescription
dataSourceYesStringThe name of your data source or cluster
databaseYesStringThe name of the database in the data source
collectionYesStringThe name of a created collection in the specified database
filterNoObjectA query operator to filter the documents

All the requests return a response in JSON or EJSON format, including the information according to the status code: 200 Success, 400 Bad Request, and 401 Unauthorized.

For more examples and to learn how to work with batches, go to the Atlas Data API documentation.

Managing the template

Considering that this initial setup may not be optimal for your specific application, all settings can be customized any time you need by using Azion Console.

To manage and edit your application’s settings, proceed as follows:

Access Console

Access Console.

Select Applications

On the upper-left corner, select Products menu > Applications.

  • You’ll be redirected to the Applications page. It lists all the applications you’ve created.
Select your application

Find the application related to your template and select it.

  • The list is organized alphabetically. You can also use the search bar located in the upper-left corner of the list; currently, it filters only by Application Name.

After selecting the application you’ll work on, you’ll be directed to a page containing all the settings you can configure.

Read the documentation about managing applications for more details.

Adding a custom domain

The application created during the deployment has an assigned Azion Workload domain to make it accessible through the browser. The domain has the following format: xxxxxxxxxx.map.azionedge.net/. However, you can add a custom domain for users to access your application through it.

For more information, refer to Domains.