MongoDB

Create an integration to manage access to a MongoDB instance

The MongoDB integration helps you to securely discover and manage your MongoDB resources through Apono.

After integrating MongoDB with Apono, you'll be able to:

  • Automate resource discovery and mapping across your MongoDB infrastructure

  • Enable administrators to implement just-in-time, least-privilege access policies and securely manage permissions

  • Allow users to request temporary access to specific clusters, roles, databases, and collections

Review the following prerequisites and implementation steps to complete this integration.


Prerequisites

Item
Description

Apono Connector

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

MongoDB Information

Information for the database instance to be integrated:

  • Hostname

  • Port

This information can be obtained from a connection string.


Create a user

You must create a MongoDB user for the Apono connector.

Follow these steps to create a user:

  1. In your MongoDB instance, switch to the admin database.

use admin;
  1. Create a user (user) and password (pwd) for the Apono connector.

For more information on creating a user, refer to MongoDB's Create a User on Self-Managed Deployments.

db.createUser({
    user: "apono-connector",
    pwd: "password",
    roles: [
        {
            "role" : "clusterMonitor",
            "db" : "admin"
        },
        {
            "role" : "userAdminAnyDatabase",
            "db" : "admin"
        },
        {
            "role" : "readWriteAnyDatabase",
            "db" : "admin"
        },
        {
            "role" : "clusterManager",
            "db" : "admin"
        }
    ]
});
  1. Create a secret with the credentials from step 2. Use the following key-value pair structure when generating the secret. Be sure to replace #PASSWORD with the actual value. If you used a different name for the user, replace apono-connector with the name you assigned to the user.

"username": "apono-connector",
"password": "#PASSWORD"

You can also input the user credentials directly into the Apono UI during the integration process.


Integrate MongoDB

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 MongoDB. The Connect Integration page appears.

  2. Under Discovery, select one or multiple resource types.

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. Choosing a connector links Apono to all the services available on the account where the connector is located.

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

    Hostname

    Address of the MongoDB instance

    Port

    Network port the MongoDB instance is listening on for connections

    By default, MongoDB uses port 27017.

  3. Click Next. The Secret Store section expands.

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

  5. Define the Get more with Apono settings.

    Setting
    Description

    Credential rotation period (in days)

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

    Learn more about the Credentials Rotation Policy.

    User cleanup after access is revoked (in days)

    (Optional) Defines the number of days after access has been revoked that the user should be deleted

    Learn more about Periodic User Cleanup & Deletion.

    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

    (Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners:

    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

    (Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners:

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

    2. 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.

  6. Click Confirm.

💡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 instance.

Last updated