MongoDB Atlas Portal

Create an integration to manage access to a MongoDB Atlas Portal instance and its resources

MongoDB Atlas is a fully-managed cloud database service that automates database administration tasks for MongoDB. It supports multiple cloud providers and offers advanced features like real-time analytics and security controls. Atlas simplifies database management, allowing organizations to focus on application development with a scalable, flexible database solution that adapts to changing needs and workloads.

Through this integration, Apono helps you securely manage access to your MongoDB Atlas UI Organizations and Projects.

Single Mongo Cluster Integration

Prerequisites

Item
Description

Apono Connector

On-prem connection serving as a bridge between a MongoDB Atlas instance and Apono:

Atlas Command Line Interface (Atlas CLI)

MongoDB Atlas Info

Information for the MongoDB Atlas UI resources to be integrated:

  • Cluster name

  • Organization ID

Create an API key

You must create an API key with the Organization User role for the Apono connector.

Follow these steps to create the API key:

  1. In the Atlas CLI, create the API key. The following command will return the public and private API keys in the response.

Be sure to replace <ORGANIZATION_ID> with the organization ID of the MongoDB Atlas UI to integrate.

atlas organizations apiKeys create --role ORG_OWNER --desc apono_connector --orgId <ORGANIZATION_ID>

  1. Using the keys from the previous step, create a secret for the MongoDB Atlas UI instance.

// Replace #PUBLIC_KEY and #PRIVATE_KEY with the actual key values.

"public_key": "#PUBLIC_KEY"
"private_key": "#PRIVATE_KEY"

You can now integrate your MongoDB Atlas UI resources .

Integrate MongoDB Atlas UI

You can also use the steps below to integrate with Apono using Terraform.

In step 11, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.

Follow these steps to complete the integration:

  1. On the Catalog tab, click Mongo Atlas Portal. The Connect Integration page appears.

  2. Under Discovery, click one or both resource types to sync with Apono.

Apono automatically discovers and syncs all the instances in the environment. After syncing, you can manage access flows to these resources.

  1. Click Next. The Apono connector section expands.

  2. From the dropdown menu, select a connector.

If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).

  1. Click Next. The Integration Config section expands.

  2. Define the Integration Config settings.

    Setting
    Description

    Integration Name

    Unique, alphanumeric, user-friendly name used to identify this integration when constructing an access flow

    Organization ID

    ID of the organization of the MongoDB Atlas UI instance to connect

  3. Click Next. The Secret Store section expands.

  4. Associate the secret or credentials.

  5. Click Next. The Get more with Apono section expands.

  6. Define the Get more with Apono settings.

    Setting
    Description

    Credential Rotation

    (Optional) Number of days after which the database credentials must be rotated

    Custom Access Details

    (Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.

    Integration Owner

    1. From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.

    2. From the Value dropdown menu, select one or multiple users or groups.

    NOTE: When Resource Owner is defined, an Integration Owner must be defined.

    Resource Owner

    1. Enter a Key name. This value is the name of the tag created in your cloud environment.

    1. From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.

    NOTE: When this setting is defined, an Integration Owner must also be defined.

  7. Click Confirm.

Multiple Mongo Clusters Integration ("deep discovery")

Apono provides enhanced integration capabilities with MongoDB Atlas Portal, permitting the discovery and management of multiple clusters simultaneously. This guide outlines the prerequisites and detailed steps necessary for setting up and configuring the deep discovery integration.

To discover multiple clusters in an Organization, Apono creates a Sub Integration for every discovered cluster, with its own Databases, Documents, and Roles.

Prerequisites

Ensure you have the following items before beginning the integration process:

Item
Description

Apono Account

An Apono account with administrator access.

MongoDB Atlas Account

A MongoDB Atlas account with organization-level access.

Atlas Command Line Interface (CLI)

Apono Connector

Network Connectivity

Ensure network connectivity between your Apono Connector and MongoDB Atlas clusters.

Create an API Key

You must create an API key with the Organization Owner role for the Apono connector.

Follow these steps to create the API key:

  1. In the Atlas CLI, create the API key. The following command will return the public and private API keys in the response.

Be sure to replace <ORGANIZATION_ID> with the organization ID of the MongoDB Atlas UI to integrate.

atlas organizations apiKeys create --role ORG_OWNER --desc apono_connector --orgId <ORGANIZATION_ID>

  1. Using the keys from the previous step, create a secret for the MongoDB Atlas UI instance.

// Replace #PUBLIC_KEY and #PRIVATE_KEY with the actual key values.

"public_key": "#PUBLIC_KEY"
"private_key": "#PRIVATE_KEY"

Please note: Only AWS Secret Store and Azure Vault are supported for this integration at this time.

Configure Apono Integration

  1. Navigate to the Apono Catalog and select MongoDB Atlas Portal integration.

  2. Click Connect Integration.

  3. Under Discovery, select your desired resource types. Make sure to select resources under both Integration and Sub Integration: \

  4. Choose your Apono Connector from the dropdown menu.

  5. Enter a unique integration name.

  6. Provide your MongoDB Atlas Organization ID.

  7. Select the secret created in Step 2.

Configure Network Access (If Required)

For clusters in different networks or VPCs:

  1. Create additional Apono Connectors in each network/VPC hosting clusters.

  2. Tag each Mongo Cluster:

    Key: apono-connector-id
Value: <CONNECTOR_ID>

    Replace <CONNECTOR_ID> with the ID of the Apono Connector in the cluster's network.

Configure Connection Types (If Required)

Choose the appropriate connection type:

  1. Standard connection: No additional configuration needed.

  2. Private connection: Tag the cluster with:

    Key: apono-connection-type
Value: Private

  3. Private endpoint connection: Apply these tags:

    Key: apono-connection-type
Value: PrivateEndpoint

    And:

    Key: apono_private_endpoint_id
Value: <PRIVATE_ENDPOINT_ID>

Finalize Integration

  1. Review all configurations in the Apono integration form.

  2. Click Confirm to complete the setup.

Limitations

  • Deep discovery currently supports only AWS and Azure secret stores.

  • All Apono Connectors must have proper network access to their MongoDB Atlas clusters.

Explore additional Apono capabilities for access management in the Apono Catalog.

💡Are you integrating with Apono using Terraform?

If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:

  1. At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.

  2. Click to copy the code.

  3. Make any additional edits.

  4. Deploy the code in your Terraform.

Refer to Integration Config Metadata for more details about the schema definition.

Now that you have completed this integration, you can create access flows that grant permission to your MongoDB Atlas UI Organizations and Projects.

PreviousMongoDB AtlasNextMySQL

Last updated