Skip to content

Commit 024c2ef

Browse files
committed
reviews
1 parent 941d37f commit 024c2ef

File tree

6 files changed

+22
-18
lines changed

6 files changed

+22
-18
lines changed

docs/integrations/data-ingestion/clickpipes/mongodb/add_table.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Adding specific tables to a ClickPipe'
3-
description: 'Describes the steps need to add specific tables to a ClickPipe.'
3+
description: 'Describes the steps needed to add specific tables to a ClickPipe.'
44
sidebar_label: 'Add Table'
55
slug: /integrations/clickpipes/mongodb/add_table
66
show_title: false

docs/integrations/data-ingestion/clickpipes/mongodb/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,17 @@ import Image from '@theme/IdealImage';
2323
Currently, ingesting data from MongoDB to ClickHouse Cloud via ClickPipes is in Private Preview.
2424
:::
2525

26-
You can use ClickPipes to ingest data from your MongoDB database into ClickHouse Cloud. The source MongoDB database can be hosted on-premises or in the cloud using services like Mongo Atlas.
26+
:::note
27+
In the ClickHouse Cloud console and documentation, "table" and "collection" are used interchangeably for MongoDB.
28+
:::
29+
30+
You can use ClickPipes to ingest data from your MongoDB database into ClickHouse Cloud. The source MongoDB database can be hosted on-premises or in the cloud using services like MongoDB Atlas.
2731

2832
## Prerequisites {#prerequisites}
2933

3034
To get started, you first need to ensure that your MongoDB database is correctly configured for replication. The configuration steps depend on how you're deploying MongoDB, so please follow the relevant guide below:
3135

32-
1. [Mongo Atlas](./mongodb/source/atlas)
36+
1. [MongoDB Atlas](./mongodb/source/atlas)
3337

3438
2. [Generic MongoDB](./mongodb/source/generic)
3539

@@ -39,7 +43,6 @@ Once your source MongoDB database is set up, you can continue creating your Clic
3943

4044
Make sure you are logged in to your ClickHouse Cloud account. If you don't have an account yet, you can sign up [here](https://cloud.clickhouse.com/).
4145

42-
[//]: # ( TODO update image here)
4346
1. In the ClickHouse Cloud console, navigate to your ClickHouse Cloud Service.
4447

4548
<Image img={cp_service} alt="ClickPipes service" size="lg" border/>

docs/integrations/data-ingestion/clickpipes/mongodb/pause_and_resume.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ There are scenarios where it would be useful to pause a MongoDB ClickPipe. For e
2727
<Image img={pause_dialog} border size="md"/>
2828

2929
4. Head over to the **Metrics** tab.
30-
5. In around 5 seconds (and also on page refresh), the status of the pipe should be **Paused**.
30+
5. Wait for the status of the pipe to be **Paused**.
3131

3232
<Image img={pause_status} border size="md"/>
3333

@@ -43,4 +43,4 @@ There are scenarios where it would be useful to pause a MongoDB ClickPipe. For e
4343
<Image img={resume_dialog} border size="md"/>
4444

4545
5. Head over to the **Metrics** tab.
46-
6. In around 5 seconds (and also on page refresh), the status of the pipe should be **Running**.
46+
6. Wait for the status of the pipe to be **Running**.

docs/integrations/data-ingestion/clickpipes/mongodb/resync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ since initial load with parallel threads is involved each time.
4141

4242
4. A dialog box should appear for confirmation. Click on Resync again.
4343
5. Head over to the **Metrics** tab.
44-
6. In around 5 seconds (and also on page refresh), the status of the pipe should be **Setup** or **Snapshot**.
44+
6. Wait for the status of the pipe to be **Setup** or **Snapshot**.
4545
7. The initial load of the resync can be monitored in the **Tables** tab - in the **Initial Load Stats** section.

docs/integrations/data-ingestion/clickpipes/mongodb/source/atlas.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
sidebar_label: 'Mongo Atlas'
3-
description: 'Step-by-step guide on how to set up Mongo Atlas as a source for ClickPipes'
2+
sidebar_label: 'MongoDB Atlas'
3+
description: 'Step-by-step guide on how to set up MongoDB Atlas as a source for ClickPipes'
44
slug: /integrations/clickpipes/mongodb/source/atlas
5-
title: 'Mongo Atlas source setup guide'
5+
title: 'MongoDB Atlas source setup guide'
66
---
77

88
import mongo_atlas_configuration from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/mongo-atlas-cluster-overview-configuration.png'
@@ -13,13 +13,13 @@ import mongo_atlas_add_roles from '@site/static/images/integrations/data-ingesti
1313
import mongo_atlas_restrict_access from '@site/static/images/integrations/data-ingestion/clickpipes/mongodb/mongo-atlas-restrict-access.png'
1414
import Image from '@theme/IdealImage';
1515

16-
# Mongo Atlas source setup guide
16+
# MongoDB Atlas source setup guide
1717

1818
## Configure oplog retention {#enable-oplog-retention}
1919

2020
Minimum oplog retention of 24 hours is required for replication. We recommend setting the oplog retention to 72 hours or longer to ensure that the oplog is not truncated before the initial snapshot is completed. To set the oplog retention via UI:
2121

22-
1. Navigate to your cluster's `Overview` tab in the Atlas console and click on the `Configuration` tab.
22+
1. Navigate to your cluster's `Overview` tab in the MongoDB Atlas console and click on the `Configuration` tab.
2323
<Image img={mongo_atlas_configuration} alt="Navigate to cluster configuration" size="lg" border/>
2424

2525
2. Click `Additional Settings` and scroll down to `More Configuration Options`.
@@ -32,7 +32,7 @@ Minimum oplog retention of 24 hours is required for replication. We recommend se
3232

3333
## Configure a database user {#configure-database-user}
3434

35-
Once you are logged in to your Atlas console, click `Database Access` under the Security tab in the left navigation bar. Click on "Add New Database User".
35+
Once you are logged in to your MongoDB Atlas console, click `Database Access` under the Security tab in the left navigation bar. Click on "Add New Database User".
3636

3737
ClickPipes requires password authentication:
3838

@@ -43,7 +43,7 @@ ClickPipes requires a user with the following roles:
4343
- `readAnyDatabase`
4444
- `clusterMonitor`
4545

46-
You can find them in the `Specific Priviledges` section:
46+
You can find them in the `Specific Privileges` section:
4747

4848
<Image img={mongo_atlas_add_roles} alt="Configure user roles" size="lg" border/>
4949

docs/integrations/data-ingestion/clickpipes/mongodb/source/generic.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ Minimum oplog retention of 24 hours is required for replication. We recommend se
2020
You can check your current oplog retention by running the following command in the MongoDB shell (you must have `clusterMonitor` role to run this command):
2121

2222
```javascript
23-
db.serverStatus().oplogTruncation.oplogMinRetentionHours
23+
db.getSiblingDB("admin").serverStatus().oplogTruncation.oplogMinRetentionHours
2424
```
2525

26-
To set the oplog retention to 72 hours, run the following command as an admin user:
26+
To set the oplog retention to 72 hours, run the following command on each node in the replica set as an admin user:
2727

2828
```javascript
2929
db.adminCommand({
@@ -32,13 +32,14 @@ db.adminCommand({
3232
})
3333
```
3434

35+
For more details on the `replSetResizeOplog` command and oplog retention, see [MongoDB documentation](https://www.mongodb.com/docs/manual/reference/command/replSetResizeOplog/).
36+
3537
## Configure a database user {#configure-database-user}
3638

3739
Connect to your MongoDB instance as an admin user and execute the following command to create a user for MongoDB CDC ClickPipes:
3840

3941
```javascript
40-
use admin;
41-
db.createUser({
42+
db.getSiblingDB("admin").createUser({
4243
user: "clickpipes_user",
4344
pwd: "some_secure_password",
4445
roles: ["readAnyDatabase", "clusterMonitor"],

0 commit comments

Comments
 (0)