MongoDB Replica Set Setup Guide

Connect directly (TLS required)

IMPORTANT: You must have TLS enabled on your replica set to connect directly to Fivetran. Follow MongoDB’s TLS configuration instructions to enable TLS on your replica set.

Fivetran connects directly to your MongoDB replica set. This is the simplest and most secure method.

To connect directly, configure your firewall and/or other access control systems to allow incoming connections to your MongoDB port (usually27017) from Fivetran’s IPs for your replica set’s region. For help, see MongoDB’s Security documentation.

Connect using SSH (TLS optional)

Fivetran connects to a separate server in your network that provides an SSH tunnel to your replica set. You must connect through SSH if your database is in an inaccessible subnet.

To connect using SSH, configure your firewall and/or other access control systems to allow incoming connections to your MongoDB port (usually 27017) from your SSH tunnel server’s IP.

Before you proceed to the next step, you must follow our SSH connection instructions. If you want Fivetran to tunnel SSH over TLS, follow MongoDB’s TLS configuration instructions to enable TLS on your replica set.

Connect using AWS PrivateLink BETA

IMPORTANT: You must have a Business Critical plan to use AWS PrivateLink.

AWS PrivateLink allows VPCs and AWS-hosted or on-premises services to communicate with one another without exposing traffic to the public internet. Learn more in AWS’ PrivateLink documentation.

Follow our AWS PrivateLink setup guide to configure PrivateLink for your database.

MongoDB shell

1. Open the MongoDB shell.

2. Connect to your replica set or primary node using the MongoDB shell as an admin user.

3. Go to the admin database.

4. Execute the following command to create a user for Fivetran. Replace <username> and <password> with a username and password of your choice.

      use admin
      db.createUser({
        user: "<username>",
        pwd: "<password>",
        roles: [ "readAnyDatabase" ]
      })
   

   TIP : The Mongo shell command to create a user is db.AddUser() for versions 2.x.

   For v3.2 and greater, the built-in role readAnyDatabase no longer includes the local database. Instead, you must create the user with the following roles. Replace <username> and <password> with a username and password of your choice.

      use admin
      db.createUser({
        user: "<username>",
        pwd: "<password>",
        roles: [ "readAnyDatabase", {role: "read", db: "local"} ]
      })
   

   Read MongoDB’s built-in roles documentation for more details.

MongoDB Atlas

1. Log in to the MongoDB Atlas dashboard.

2. In the Security section of the left menu, select Database Access.

3. Click New Database User.

4. Choose the password authentication method.

5. Enter the username and password for the new Fivetran user.

6. In the Database User Privileges drop-down menu, select Grant Specific User Privileges.

7. Under Specific Privileges, add the following roles/privileges:

   • readAnyDatabase
   • read on the local database

8. Click Add User.

For more information, see MongoDB Atlas’ configure users documentation.