Connect to Azure Cosmos DB for MongoDB

Learn to create a connection to Azure Cosmos DB for MongoDB to use as a target for OCI GoldenGate.

Before you begin

Before you create the connection, ensure that you:
  • Review how OCI GoldenGate connects to your source and targets.
  • Configure the required policies to enable secure Vault and Secrets access, such as use secrets, use vaults, and read secret-bundles. For more information, see Minimum recommended policies.
  • Configure a MongoDB replicat set:
    • OCI GoldenGate for Big Data uses the operations log (oplog) to read Change Data Capture (CDC) records. The oplog is a capped collection in MongoDB that maintains a rolling record of all operations that modify the database. Oplog files are created when a replica set is enabled in MongoDB.
    • MongoDB Atlas comes preconfigured with a Replicat set. For on-premises MongoDB deployments, you must manually configure and deploy a Replicat set to enable oplog and CDC functionality. For on premises MongoDB, you need to deploy a Replica set.
  • Have MongoDB version 3.6 or later.
  • Have OCI GoldenGate support to capture the following operations: INSERT, UPDATE, DELETE.

Create the connection

To create an Azure Cosmos DB for MongoDB connection:
  1. From the OCI GoldenGate Overview page, click Connections.
    You can also click Create Connection under the Get started section and skip to step 3.
  2. On the Connections page, click Create Connection.
  3. On the Create Connection page, complete the fields as follows:
    1. For Name, enter a name for the connection.
    2. (Optional) For Description, enter a description that helps you distinguish this connection from others.
    3. (For GoldenGate on Multicloud only) Select your Subscription, and then complete the following fields.
      1. From the Compartment dropdown, select the compartment in which the Resource Anchor resides.
      2. Select the Multicloud partner region.
      3. Select your Partner availability zone. The available options populate based on the selected Multicloud partner region.
    4. For Compartment, select the compartment in which to create the connection.
    5. From the Type dropdown, select Azure Cosmos DB for MongoDB.
    6. For Connection string, enter the database's connection string.

      Note:

      If you enter a private IP, then OCI GoldenGate rewrites the private IP in the format, ip-10-0-0-0.ociggsvc.oracle.vcn.com.
    7. For Username, enter the username to connect to the database with.
    8. Select the Password secret. If located in a different compartment, use the dropdown to change compartments.

      Note:

      • Secrets are credentials such as passwords, certificates, SSH keys, or authentication tokens that you use with OCI services. To create a secret, see Creating a secret. Ensure that you:
        • Select Manual secret generation.
        • Paste the credentials into Secret contents.
      • If you prefer not to use password secrets, ensure that you deselect Use secrets in vault in the Security section under Advanced Options, located at the bottom of this form.
    9. For Security settings, select a Security protocol:
      • Plain
      • TLS
      • MTLS
    10. Expand Show advanced options. You can configure the following options:
      • Security
        • Deselect Use vault secrets you prefer not to use password secrets for this connection. If not selected:
          • Select Use Oracle-managed encryption key to leave all encryption key management to Oracle.
          • Select Use customer-managed encryption key to select a specific encryption key stored in your OCI Vault to encrypt your connection credentials.
      • Network connectivity
        • Shared endpoint, to share an endpoint with the assigned deployment. You must allow connectivity from the deployment's ingress IP.
        • Dedicated endpoint, for network traffic through a dedicated endpoint in the assigned subnet in your VCN. You must allow connectivity from this connection's ingress IPs.

          Note:

          • If a dedicated connection remains unassigned for seven days, then the service converts it to a shared connection.
          • Learn more about Oracle GoldenGate connectivity.
      • Security attributes: Add security attributes to control access to this connection using Zero Trust Packet Routing (ZPR).
      • Tags: Add tags to organize your resources.
  4. Click Create.
After the connection is created, it appears in the Connections list. Ensure that you assign the connection to a deployment to use it as a source or target in a replication.