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

Update the cdc doc #2788

Merged
merged 1 commit into from
Aug 30, 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
3 changes: 3 additions & 0 deletions site/en/userGuide/tools/milvus-cdc/deploy-cdc-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ In the `milvus-cdc/server/configs` directory, modify the `cdc.yaml` file to cust
- __Helm__ or __Docker Compose__: Defaults to `by-dev`.

- __Operator__: Defaults to `<release_name>`.

- `replicateChan`: milvus replicate channel name, which is `{msgChannel.chanNamePrefix.cluster}/{msgChannel.chanNamePrefix.replicateMsg}` in the milvus.yaml file

- `sourceConfig.pulsar`: Pulsar configurations for the source Milvus. If the source Milvus uses Kafka for message storage, remove all Pulsar-related configurations. For more information, refer to [Pulsar-related Configurations](https://milvus.io/docs/configure_pulsar.md).

Expand All @@ -95,6 +97,7 @@ sourceConfig:
defaultPartitionName: _default
# read buffer length, mainly used for buffering if writing data to milvus-target is slow.
readChanLen: 10
replicateChan: by-dev-replicate-msg
# milvus-source mq config, which is pulsar or kafka
pulsar:
address: pulsar://localhost:6650
Expand Down
21 changes: 5 additions & 16 deletions site/en/userGuide/tools/milvus-cdc/manage-cdc-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,15 @@ curl -X POST http:_//localhost:8444/cdc \
"request_type": "create",
"request_data": {
"milvus_connect_param": {
"host": "localhost",
"port": 19530,
"username": "root",
"password": "Milvus",
"enable_tls": false,
"uri": "http://localhost:19530",
"token":"root:Milvus",
"connect_timeout": 10
},
"collection_infos": [
{
"name": "*"
}
],
"rpc_channel_info": {
"name": "by-dev-replicate-msg"
}
]
}
}'
```
Expand All @@ -63,8 +57,6 @@ __Parameters__:

- __collection_infos__: Collections to synchronize. Currently, only an asterisk (__*__) is supported, as Milvus-CDC synchronizes at the cluster level, not individual collections.

- __rpc_channel_info__: RPC channel name for synchronization, constructed by concatenating the values of __common.chanNamePrefix.cluster__ and __common.chanNamePrefix.replicateMsg__ from the source Milvus configuration, separated by a hyphen (__-__).

Expected response:

```json
Expand Down Expand Up @@ -98,8 +90,7 @@ Expected response:
{
"task_id": "xxxxx",
"milvus_connect_param": {
"host": "localhost",
"port": 19530,
"uri":"http://localhost:19530",
"connect_timeout": 10
},
"collection_infos": [
Expand Down Expand Up @@ -203,9 +194,7 @@ Expected response:
],
"milvus_connect_param": {
"connect_timeout": 10,
"enable_tls": true,
"host": "localhost",
"port": 19530
"uri":"http://localhost:19530"
},
"state": "Running",
"task_id": "xxxx"
Expand Down