Skip to content

Commit 0fcc0cc

Browse files
committed
Added steppers
1 parent 9853171 commit 0fcc0cc

1 file changed

Lines changed: 17 additions & 28 deletions

File tree

docs/cluster/integrations/mongo-cdc.md

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
(integrations-mongo-cdc)=
2-
# MongoDB CDC (Preview)
2+
# MongoDB CDC
33

44
CrateDB Cloud enables continuous data ingestion from MongoDB using Change Data
55
Capture (CDC), providing seamless, real-time synchronization of your data.
66

7-
:::{caution}
8-
This integration is currently in preview and may have restricted availability.
9-
For more information, please [contact us](https://cratedb.com/contact).
10-
:::
11-
127
## Key Concepts
138

149
The MongoDB CDC integration in CrateDB Cloud allows you to keep your data
@@ -54,7 +49,8 @@ Supported authentication methods:
5449

5550
The following steps should be performed in the MongoDB Atlas UI.
5651

57-
#### Step 1: Create a Custom Role
52+
:::::{stepper}
53+
#### Create a Custom Role
5854
1. **Navigate to Database Access**
5955
Go to **Database Access** in the MongoDB Atlas UI for the cluster you want to
6056
connect to CrateDB Cloud.
@@ -74,7 +70,7 @@ The following steps should be performed in the MongoDB Atlas UI.
7470
access permissions in the MongoDB Atlas UI later if needed.
7571

7672

77-
#### Step 2: Create a User
73+
#### Create a User
7874

7975
Depending on whether you plan to use SCRAM or X.509 authentication, create a
8076
database user with one of the following methods:
@@ -115,7 +111,7 @@ database user with one of the following methods:
115111
:::
116112

117113

118-
#### Step 3: Configure IP Access
114+
#### Configure IP Access
119115

120116
To allow CrateDB Cloud to access your MongoDB Atlas cluster, you must add the
121117
CrateDB Cloud IP addresses to the IP Access List in MongoDB Atlas.
@@ -134,7 +130,7 @@ out to our support team.
134130
:::
135131

136132

137-
#### Step 4: Access Connection String
133+
#### Access Connection String
138134

139135
You'll need to provide the connection string for your MongoDB Atlas cluster so
140136
that CrateDB Cloud can connect to it.
@@ -169,18 +165,18 @@ mongodb+srv:///?authMechanism=MONGODB-X509&retryWrites=true&w=majority
169165
Make sure to upload the X.509 certificate file when configuring the connection
170166
in CrateDB Cloud.
171167
:::
172-
173-
168+
:::::
174169

175170
### Set Up Integration in CrateDB Cloud
176171

177172
Follow these steps in the CrateDB Cloud Console to set up the MongoDB CDC integration:
178173

179-
#### Step 1: Create an Integration
174+
:::::{stepper}
175+
#### Create an Integration
180176
1. Navigate to the **Import** section in the CrateDB Cloud Console.
181177
2. Click **Create Integration** and select **MongoDB** as the source type.
182178

183-
#### Step 2: Configure Connection
179+
#### Configure Connection
184180
1. Choose **Create New Connection** or select an existing one.
185181
2. Fill in the following details:
186182
:::{tab} SCRAM Auhentication
@@ -197,15 +193,15 @@ Follow these steps in the CrateDB Cloud Console to set up the MongoDB CDC integr
197193
- **Default Database**: Specify the default database to use for this connection.
198194
:::
199195

200-
#### Step 3: Test the Connection
196+
#### Test the Connection
201197
Click **Test Connection** to verify CrateDB Cloud can connect to your MongoDB
202198
Atlas cluster. Resolve any issues if the test fails.
203199

204-
#### Step 4: Select Collection
200+
#### Select Collection
205201
Enter the database and collection name from your MongoDB Atlas cluster, that you
206202
want to sync with CrateDB Cloud.
207203

208-
#### Step 5: Select Target Table
204+
#### Select Target Table
209205
1. Specify the target table in your CrateDB Cloud cluster where the data will be synced.
210206
2. MongoDB records will be inserted into an object column called `document`.
211207
3. Select the object type for the column:
@@ -217,27 +213,21 @@ want to sync with CrateDB Cloud.
217213
However, selecting `dynamic` provides faster query performance by utilizing indexes and columnar storage.
218214
:::
219215

220-
#### Step 6: Configure Integration Settings
216+
#### Configure Integration Settings
221217
1. Enter a name for the integration.
222218
2. Select the integration mode:
223219
- **Full Load Only**: Imports the data once but doesn’t sync changes.
224220
- **Full Load and CDC**: Imports the data and syncs changes in real-time.
225221
- **CDC Only**: Syncs only new changes in real-time without importing existing data.
226222

227-
#### Step 7: Create the Integration
223+
#### Create the Integration
228224
Click **Create Integration** to finalize the setup. CrateDB Cloud will now sync
229225
your MongoDB data based on the selected settings.
230-
226+
:::::
231227
---
232228

233229
## Limitations
234230

235-
The MongoDB CDC integration is available as a preview. The feature is stable
236-
enough for broader use but may still have limitations, known issues, or
237-
incomplete features. While suitable for many use cases, it is not yet
238-
recommended for mission-critical workloads.
239-
240-
241231
### Column Name Restrictions
242232

243233
Column or property names containing square brackets (`[]`) are not supported and
@@ -258,5 +248,4 @@ CDC integration:
258248
value.
259249
- **Binary data types** other than UUIDs, which are converted to `TEXT` and
260250
**vectors**, which are converted to `ARRAY`s of numbers.
261-
- The `Decimal128` data type is not supported and is converted to a string, as
262-
CrateDB does not support a decimal data type.
251+
- The `Decimal128` data type is not supported and is converted to a string.

0 commit comments

Comments
 (0)