-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
293 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
(cluster-integrations)= | ||
# Integrations | ||
|
||
CrateDB Cloud simplifies data ingestion with fully managed integrations from | ||
external data sources. Unlike traditional import jobs, integrations run | ||
continuously, automatically importing new data into your CrateDB Cloud cluster | ||
as it becomes available. This makes them ideal for real-time data | ||
synchronization and keeping your database up to date with external systems. | ||
Fully managed by CrateDB Cloud, integrations eliminate the need for manual | ||
setup or maintenance of separate ETL pipelines. | ||
|
||
|
||
```{figure} ../_assets/img/integrations.png | ||
:width: 600px | ||
:align: center | ||
:alt: Integration in CrateDB Cloud | ||
``` | ||
|
||
:::{toctree} | ||
:maxdepth: 1 | ||
:hidden: | ||
|
||
MongoDB CDC <integrations/mongo-cdc> | ||
::: | ||
|
||
--- | ||
|
||
::: | ||
## Key Concepts | ||
::: | ||
|
||
::: | ||
### Integration | ||
::: | ||
|
||
An integration in CrateDB Cloud automatically imports data from an external data | ||
source into a table within your CrateDB Cloud cluster. It uses a secure | ||
connection to ensure data integrity and can run continuously to handle updates | ||
in real time. You can create multiple integrations for the same data source to | ||
support different tables or configurations. | ||
|
||
Currently, CrateDB Cloud supports ingestion from the following data source: | ||
- {ref}`MongoDB CDC <integrations-mongo-cdc>` | ||
|
||
More integrations are planned for future releases to expand the range of | ||
supported data sources and use cases. | ||
|
||
::: | ||
### Connection | ||
::: | ||
|
||
A "Connection" in CrateDB Cloud associates authentication credentials with a | ||
specific data source. This allows secure access to the external system and is | ||
reusable across multiple integrations. By setting up a connection once, you can | ||
streamline the process of creating and managing integrations without having to | ||
re-enter credentials for each one. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,236 @@ | ||
(integrations-mongo-cdc)= | ||
# MongoDB CDC Integration | ||
|
||
CrateDB Cloud enables continuous data ingestion from MongoDB using Change Data | ||
Capture (CDC), providing seamless, real-time synchronization of your data. | ||
|
||
## Key Concepts | ||
|
||
The MongoDB CDC integration in CrateDB Cloud allows you to keep your data | ||
synchronized between your MongoDB Atlas cluster and your CrateDB Cloud cluster | ||
in real-time. | ||
|
||
### How It Works | ||
|
||
The integration functions in two main stages: | ||
|
||
1. **Initial Sync:** | ||
The integration performs a complete scan of your MongoDB collections, | ||
importing all existing data into your CrateDB Cloud cluster. | ||
|
||
2. **Continuous Sync:** | ||
The integration uses MongoDB Change Streams to monitor changes in your | ||
MongoDB collections and syncs these updates to your CrateDB Cloud cluster | ||
in real-time, ensuring that your data remains current. | ||
|
||
### Data Consistency and Mode | ||
|
||
For continuous sync, CrateDB Cloud uses MongoDB's **full document mode** to | ||
ensure data consistency. This mode guarantees that MongoDB returns the latest | ||
majority-committed version of the updated document. | ||
|
||
While receiving partial deltas is more efficient, full document mode provides | ||
robust functionality. Support for partial deltas may be added in the future to | ||
enhance performance and flexibility. | ||
|
||
--- | ||
|
||
## Create a new Integration | ||
A MongoDB integration allows you to sync a single collection from a MongoDB | ||
Atlas cluster. You can reuse an existing connection across multiple integrations | ||
to continuously sync data from multiple MongoDB Atlas collections. | ||
|
||
Supported authentication methods: | ||
- MongoDB SCRAM Authentication | ||
- MongoDB X.509 Authentication | ||
|
||
|
||
### Set Up MongoDB Atlas Authentication | ||
|
||
The following steps should be performed in the MongoDB Atlas UI. | ||
|
||
#### Step 1: Create a Custom Role | ||
1. **Navigate to Database Access** | ||
Go to **Database Access** in the MongoDB Atlas UI for the cluster you want to | ||
connect to CrateDB Cloud. | ||
|
||
2. **Add a Custom Role** | ||
Under **Custom Roles**, click **Add New Custom Role**. | ||
|
||
3. **Set Up Read-Only Access** | ||
Assign the following actions or roles to the custom role: | ||
- `find` | ||
- `changeStream` | ||
- `collStats` | ||
|
||
Specify the databases and collections for these actions. You can update | ||
access permissions in the MongoDB Atlas UI later if needed. | ||
|
||
|
||
#### Step 2: Create a User | ||
|
||
Depending on whether you plan to use SCRAM or X.509 authentication, create a | ||
database user with one of the following methods: | ||
|
||
:::{tab} SCRAM Auhentication | ||
|
||
1. **Navigate to Database Access** | ||
In the MongoDB Atlas UI, go to **Database Access** and click **Add New | ||
Database User**. | ||
|
||
2. **Set Authentication Method** | ||
Choose **Password** as the authentication method and enter a username and | ||
password for the database user. | ||
|
||
3. **Assign the Role** | ||
Under **Database User Privileges**, select the custom role created in Step 1. | ||
|
||
4. **Copy User Credentials** | ||
Click **Add User**, and make sure to record the username and password. These | ||
credentials will be used later in the CrateDB Cloud Console. | ||
::: | ||
|
||
:::{tab} x.509 Authentication | ||
|
||
1. **Navigate to Database Access** | ||
In the MongoDB Atlas UI, go to **Database Access** and click **Add New | ||
Database User**. | ||
|
||
2. **Set Authentication Method** | ||
Choose **Certificate** as the authentication method. | ||
|
||
3. **Assign the Role** | ||
Under **Database User Privileges**, select the custom role created in Step 1. | ||
|
||
4. **Save the Certificate** | ||
Click **Add User**, and store the certificate securely. This will be required | ||
later in the CrateDB Cloud Console. | ||
::: | ||
|
||
|
||
#### Step 3: Configure IP Access | ||
|
||
To allow CrateDB Cloud to access your MongoDB Atlas cluster, you must add the | ||
CrateDB Cloud IP addresses to the IP Access List in MongoDB Atlas. | ||
|
||
1. **Navigate to Network Access** | ||
In the MongoDB Atlas UI, go to **Network Access** from the left navigation. | ||
|
||
2. **Add IP Address** | ||
Click **Add IP Address** and choose an IP address or range to allow access. | ||
For testing purposes, you can select **Allow Access from Anywhere**, but for | ||
production, it is recommended to specify only the required IPs. | ||
|
||
:::{note} | ||
The specific IP addresses depend on the region of your CrateDB Cloud cluster. | ||
These IP addresses can also be found in the **Connection Details** section of the | ||
CrateDB Cloud Console, just before you click **Test Connection** during the | ||
setup process. | ||
|
||
**Outbound IP Addresses**: | ||
|
||
| Cloud Provider | Region | IP Addresses | | ||
|----------------|---------------|---------------------------------| | ||
| Azure | East US 2 | `52.184.241.228/32`, `52.254.31.90/32` | | ||
| Azure | West Europe | `51.105.153.175/32`, `108.142.34.5/32` | | ||
| AWS | EU West 1 | `34.255.75.224` | | ||
| AWS | US East 1 | `54.197.229.58` | | ||
| AWS | US West 2 | `54.189.16.20` | | ||
| GCP | US Central 1 | `34.69.134.49` | | ||
|
||
::: | ||
|
||
|
||
#### Step 4: Access Connection String | ||
|
||
You’ll need to provide the connection string for your MongoDB Atlas cluster so | ||
that CrateDB Cloud can connect to it. | ||
|
||
1. **Navigate to Your Cluster** | ||
In the MongoDB Atlas UI, navigate to the cluster you want to connect to CrateDB Cloud. | ||
|
||
2. **Click "Connect"** | ||
From the cluster view, click on **Connect**. | ||
|
||
3. **Select "Connect Your Application"** | ||
Choose **Connect your application** as the connection method. | ||
|
||
4. **Copy the Connection String** | ||
Copy the connection string provided in the MongoDB Atlas UI. It will look like this: | ||
|
||
``` | ||
mongodb+srv://:@/?retryWrites=true&w=majority | ||
``` | ||
|
||
--- | ||
|
||
:::{note} | ||
If you are using X.509 authentication, the connection string will look slightly | ||
different and will not include a username and password. Instead, it will | ||
reference the certificate file: | ||
|
||
``` | ||
mongodb+srv:///?authMechanism=MONGODB-X509&retryWrites=true&w=majority | ||
``` | ||
|
||
Make sure to upload the X.509 certificate file when configuring the connection | ||
in CrateDB Cloud. | ||
::: | ||
|
||
|
||
|
||
### Set Up Integration in CrateDB Cloud | ||
|
||
Follow these steps in the CrateDB Cloud Console to set up the MongoDB CDC integration: | ||
|
||
#### Step 1: Create an Integration | ||
1. Navigate to the **Import** section in the CrateDB Cloud Console. | ||
2. Click **Create Integration** and select **MongoDB** as the source type. | ||
|
||
#### Step 2: Configure Connection | ||
1. Choose **Create New Connection** or select an existing one. | ||
2. Fill in the following details: | ||
:::{tab} SCRAM Auhentication | ||
- **Connection Name**: Provide a unique name for the connection. | ||
- **Connection String**: Paste the connection string from MongoDB Atlas. | ||
- **Username**: Enter the database username (required for SCRAM). | ||
- **Password**: Enter the database password (required for SCRAM). | ||
- **Default Database**: Specify the default database to use for this connection. | ||
::: | ||
:::{tab} X.509 Auhentication | ||
- **Connection Name**: Provide a unique name for the connection. | ||
- **Connection String**: Paste the connection string from MongoDB Atlas. | ||
- **Certificate**: Upload the X.509 certificate file. | ||
- **Default Database**: Specify the default database to use for this connection. | ||
::: | ||
|
||
#### Step 3: Test the Connection | ||
Click **Test Connection** to verify CrateDB Cloud can connect to your MongoDB | ||
Atlas cluster. Resolve any issues if the test fails. | ||
|
||
#### Step 4: Select Collection | ||
Enter the database and collection name from your MongoDB Atlas cluster, that you | ||
want to sync with CrateDB Cloud. | ||
|
||
#### Step 5: Select Target Table | ||
1. Specify the target table in your CrateDB Cloud cluster where the data will be synced. | ||
2. MongoDB records will be inserted into an object column called `document`. | ||
3. Select the object type for the column: | ||
- **`dynamic`**: Allows indexing and columnar storage for faster querying. | ||
- **`ignored`**: Prevents type conflicts in CrateDB if your source data lacks a strict schema. | ||
|
||
:::{note} | ||
If your source data doesn't follow a strict schema, select `ignored` to avoid type conflicts. | ||
However, selecting `dynamic` provides faster query performance by utilizing indexes and columnar storage. | ||
::: | ||
|
||
#### Step 6: Configure Integration Settings | ||
1. Enter a name for the integration. | ||
2. Select the integration mode: | ||
- **Full Load Only**: Imports the data once but doesn’t sync changes. | ||
- **Full Load and CDC**: Imports the data and syncs changes in real-time. | ||
- **CDC Only**: Syncs only new changes in real-time without importing existing data. | ||
|
||
#### Step 7: Create the Integration | ||
Click **Create Integration** to finalize the setup. CrateDB Cloud will now sync | ||
your MongoDB data based on the selected settings. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters