Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add ssh tunneling documentation for MongoDB capture and materialization #1369

Merged
merged 1 commit into from
Feb 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions site/docs/reference/Connectors/capture-connectors/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You'll need:
that specific database. Note that we require access on the _database_ and
not individual collections. This is to so that we can run a change stream on
the database which allows for better consistency guarantees.

In order to create a user with access to all databases, use a command like so:
```
use admin;
Expand All @@ -45,14 +45,14 @@ You'll need:
roles: [ "readAnyDatabase" ]
})
```

If you are using a user with access to all databases, then in your mongodb
address, you must specify `?authSource=admin` parameter so that
authentication is done through your admin database.

In order to create a user with access to a specific database and the `local` database,
use a command like so:

```
use <your-db>;
db.createUser({
Expand Down Expand Up @@ -113,6 +113,15 @@ captures:
target: ${PREFIX}/users
```

## SSH Tunneling

As an alternative to connecting to your MongoDB instance directly, you can allow secure connections via SSH tunneling. To do so:

1. Refer to the [guide](../../../../guides/connect-network/) to configure an SSH server on the cloud platform of your choice.

2. Configure your connector as described in the [configuration](#configuration) section above, with the addition of the `networkTunnel` stanza to enable the SSH tunnel, if using. See [Connecting to endpoints on secure networks](../../../concepts/connectors.md#connecting-to-endpoints-on-secure-networks) for additional details and a sample.


## Backfill and real-time updates

The connector starts by backfilling data from the specified collections until it
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ materializations:
source: ${PREFIX}/users
```

## SSH Tunneling

As an alternative to connecting to your MongoDB instance directly, you can allow secure connections via SSH tunneling. To do so:

1. Refer to the [guide](../../../../guides/connect-network/) to configure an SSH server on the cloud platform of your choice.

2. Configure your connector as described in the [configuration](#configuration) section above, with the addition of the `networkTunnel` stanza to enable the SSH tunnel, if using. See [Connecting to endpoints on secure networks](../../../concepts/connectors.md#connecting-to-endpoints-on-secure-networks) for additional details and a sample.

## Delta updates

This connector supports both standard (merge) and [delta updates](../../../concepts/materialization.md#delta-updates).
Expand Down
Loading