You are viewing a plain text version of this content. The canonical link for it is here.

Posted to dev@rocketmq.apache.org by GitBox <gi...@apache.org> on 2020/04/05 14:47:50 UTC

[GitHub] [rocketmq-externals] ClementIV opened a new pull request #548: docs(connect): upload gitbook markdown code

ClementIV opened a new pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548

## What is the purpose of the change

1. upload gitbook markdown code

Close: #547

## Brief changelog

XX

## Verifying this change

XXXX

Follow this checklist to help us incorporate your contribution quickly and easily. Notice, `it would be helpful if you could finish the following 5 checklist(the last one is not necessary)before request the community to review your PR`.

- [x] Make sure there is a [Github issue](https://github.com/apache/rocketmq/issues) filed for the change (usually before you start working on it). Trivial changes like typos do not require a Github issue. Your pull request should address just this issue, without pulling in other changes - one PR resolves one issue.
- [x] Format the pull request title like `[ISSUE #123] Fix UnknownException when host config not exist`. Each commit in the pull request should have a meaningful subject line and body.
- [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [x] Write necessary unit-test(over 80% coverage) to verify your logic correction, more mock a little better when cross module dependency exist. If the new feature or significant change is committed, please remember to add integration-test in [test module](https://github.com/apache/rocketmq/tree/master/test).
- [x] Run `mvn -B clean apache-rat:check findbugs:findbugs checkstyle:checkstyle` to make sure basic checks pass. Run `mvn clean install -DskipITs` to make sure unit-test pass. Run `mvn clean test-compile failsafe:integration-test` to make sure integration-test pass.
- [ ] If this contribution is large, please file an [Apache Individual Contributor License Agreement](http://www.apache.org/licenses/#clas).

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403721468
 
 

 ##########
 File path: docs/cn/GitBook/connector/replicator/rocketmq-replicator.md
 ##########
 @@ -0,0 +1,135 @@
+---
+description: Replicator快速开始
+---
+
+# Replicator快速开始
+
+## RocketMQ Replicator Quick Start
+
+### 环境依赖
+
+1. **64bit JDK 1.8+;**
+2. **Maven 3.2.x或以上版本;**
+3. **Git**
+4. **RocketMQ集群环境;**
+
+### 项目下载
+
+```bash
+$ git clone https://github.com/apache/rocketmq-externals.git
+```
+
+### 项目构建
+
+```bash
+$ cd rocketmq-externals/rocketmq-replicator
+$ mvn clean install -Prelease-all -DskipTest -U
+
+### 出现如下信息，项目构建成功
+ 
+
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  14.432 s
+[INFO] Finished at: 2019-10-11T14:08:41+08:00
+[INFO] ------------------------------------------------------------------------
+```
+
+### 项目部署使用
+
+打包成功后将`rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar`（fatjar）放到`runtime`配置的`pluginPaths`目录下
+
+```bash
+$ cd target
+# 拷贝jar包到RocketMQ Runtime插件文件夹
+$ cp rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar /usr/local/connectors-plugin/
+```
+
+{% hint style="warning" %}
+**RocketMQ Runtime插件文件路径可配置，需要和Runtime参数中的插件路径配置相对应。**
+
+注：[Runtime 插件路径配置](../../rocketmq-connect-1/rocketmq-runtime/runtime-can-shu-pei-zhi.md#runtime-pei-zhi-can-shu-shuo-ming)
+{% endhint %}
+
+### 启动
+
+
+
+发送GET请求，启动rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${rocketmq-replicator-name}
+ ?config={
+ "connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+ "source-rocketmq":"xxxx:9876",
+ "target-rocketmq":"xxxxxxx:9876",
+ "replicator-store-topic":"replicatorTopic",
+ "taskDivideStrategy":"0",
+ "white-list":"TopicTest,TopicTest2",
+ target-cluster":"{RocketMQCluster-Target}",
 
 Review comment:
   ```suggestion
   ""target-cluster":"{RocketMQCluster-Target}",
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403715137
 
 

 ##########
 File path: docs/cn/GitBook/README.md
 ##########
 @@ -0,0 +1,76 @@
+---
+description: Message Connector相关概念简介
+---
+
+# Message Connector 简介
+
+### 消息路由（Message Connector）是什么？
+
+{% hint style="success" %}
+
+**Connector的定义**
+
+连接器实例属于逻辑概念，其负责维护特定数据系统的相关配置，比如链接地址、需要同步哪些数据等信息；在connector实例被启动后，connector可以根据配置信息，对解析任务进行拆分，分配出task。
+
+{% endhint %}
+
+**消息路由**主要用于不同地域之间消息的同步，保证地域之间的数据一致性和复制备份。RocketMQ的消息路由特性打通了多个集群之间的消息互通，高效地实现了分布在不同地域之间的RocketMQ集群的消息同步复制
+
+![Messaging Connector &#x67B6;&#x6784;&#x56FE;](.gitbook/assets/image.png)
+
+### 消息路由（Message Connector）的几个概念：
+
+ 简单理解**Message Connector**就是借RocketMQ、kafka等从某个系统获取数据，借助消费消息写入到其他系统。**主要由Source Connector，Sink Connector、Runtime组成。**
+
+ **Source Connector**负责从其它系统获取数据。
+
+ **Sink Connector**负责从Producer中消费消息，将数据写入到另外的系统。
+
+ **Runtime**是Source ，Sink connector的运行时环境，负责加载Connector，提供RESTful接口，启动Connector任务，集群节点之间服务发现，配置同步，消费进度保存，故障转移，负载均衡等能力。
+
+**OpenMessaging** 是一套消息中间件领域的规范。**OpenMessaging Connect是Connect方面的api**，OpenMessaging 还有其他各种消息中间件邻域的规范，例如mq客户端规范，存储规范，实现OpenMessaging 规范可以做到厂商无关。**具体的Connector可以基于这套规范实现**。  
+
+
+#### RocketMQ Connector的几个概念：
+
+![RocketMQ Connect &#x603B;&#x89C8;](.gitbook/assets/rocketmq-connect-overview-3.png)
+
+简单理解RocketMQ Connect就是借RocketMQ从其他系统获取数据发送到RocketMQ，然后从RocketMQ消费消息写入到其他系统。主要由**Source Connector，Sink Connector，Runtime**组成。
+
+**Source Connector**负责从其它系统获取数据，通过Producer发送到到RocketMQ。
+
+**Sink Connector负**责从Producer中消费消息，将数据写入到另外的系统
 
 Review comment:
   ```suggestion
   **Sink Connector** 负从Producer中消费消息，将数据写入到另外的系统
   ```
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403762824
 
 

 ##########
 File path: docs/cn/GitBook/connector/replicator/rocketmq-replicator.md
 ##########
 @@ -0,0 +1,135 @@
+---
+description: Replicator快速开始
+---
+
+# Replicator快速开始
+
+## RocketMQ Replicator Quick Start
+
+### 环境依赖
+
+1. **64bit JDK 1.8+;**
+2. **Maven 3.2.x或以上版本;**
+3. **Git**
+4. **RocketMQ集群环境;**
+
+### 项目下载
+
+```bash
+$ git clone https://github.com/apache/rocketmq-externals.git
+```
+
+### 项目构建
+
+```bash
+$ cd rocketmq-externals/rocketmq-replicator
+$ mvn clean install -Prelease-all -DskipTest -U
+
+### 出现如下信息，项目构建成功
+ 
+
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  14.432 s
+[INFO] Finished at: 2019-10-11T14:08:41+08:00
+[INFO] ------------------------------------------------------------------------
+```
+
+### 项目部署使用
+
+打包成功后将`rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar`（fatjar）放到`runtime`配置的`pluginPaths`目录下
+
+```bash
+$ cd target
+# 拷贝jar包到RocketMQ Runtime插件文件夹
+$ cp rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar /usr/local/connectors-plugin/
+```
+
+{% hint style="warning" %}
+**RocketMQ Runtime插件文件路径可配置，需要和Runtime参数中的插件路径配置相对应。**
+
+注：[Runtime 插件路径配置](../../rocketmq-connect-1/rocketmq-runtime/runtime-can-shu-pei-zhi.md#runtime-pei-zhi-can-shu-shuo-ming)
+{% endhint %}
+
+### 启动
+
+
+
+发送GET请求，启动rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${rocketmq-replicator-name}
+ ?config={
+ "connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+ "source-rocketmq":"xxxx:9876",
+ "target-rocketmq":"xxxxxxx:9876",
+ "replicator-store-topic":"replicatorTopic",
+ "taskDivideStrategy":"0",
+ "white-list":"TopicTest,TopicTest2",
+ target-cluster":"{RocketMQCluster-Target}",
+"source-cluster":"{RocketMQCluster-Source}",
+ "task-parallelism":"2",
+ "source-record-converter":"org.apache.rocketmq.connect.runtime.converter.JsonConverter"
+ }
+```
+
+* [参数说明文档](replicator-can-shu-pei-zhi.md)
+* 启动实例
+
+```http
+http://localhost:8081/connectors/replicator-test?config={
+"connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+"source-rocketmq":"xxx.xxx.xxx.xxx:9876",
+"target-rocketmq":"xxx.xxx.xxx.xxx:9876",
+"replicator-store-topic":"replicatorTopic",
+"taskDivideStrategy":"0",
+"white-list":"fileTopic",
+"task-parallelism":"4",
+"target-cluster":"RocketMQCluster-xxx",
+"source-cluster":"RocketMQCluster-xxx",
+"source-record-converter":"org.apache.rocketmq.connect.runtime.converter.JsonConverter",
+"topic.rename.format":"rename-${topic}"
+}
+```
+
+{% hint style="info" %}
+* 上述namesrv地址需要换成自己的地址
+* 参数'replicator-store-topic' 的topic要先在runtime集群创建
+* 集群名称要替换成对应的集群名称
+{% endhint %}
+
+### 启动前确认
+
+{% hint style="info" %}
+请确认启动参数中**replicator-store-topic**和**white-list**的topic已经在**Source集群**创建
+
+[Topic创建文档](https://rocketmq-1.gitbook.io/rocketmq-connector/quick-start/rocketmq-runtime-shi-yong#chuang-jian-topic)
+{% endhint %}
+
+### 停止
+
+发送GET请求，停止rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${replicator-name}/stop
+```
+
+* 停止示例
+
+```http
+http://localhost:8081/connectors/replicator-test/stop
+```
+
+{% hint style="info" %}
+更多参数设置说明与Connector操作请参考 
+
+* [replicator配置参数说明](replicator-can-shu-pei-zhi.md)
+* [RESTful 接口](../../rocketmq-connect-1/rocketmq-runtime/restful-jie-kou.md)
 
 Review comment:
   link is incorrect

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403715137
 
 

 ##########
 File path: docs/cn/GitBook/README.md
 ##########
 @@ -0,0 +1,76 @@
+---
+description: Message Connector相关概念简介
+---
+
+# Message Connector 简介
+
+### 消息路由（Message Connector）是什么？
+
+{% hint style="success" %}
+
+**Connector的定义**
+
+连接器实例属于逻辑概念，其负责维护特定数据系统的相关配置，比如链接地址、需要同步哪些数据等信息；在connector实例被启动后，connector可以根据配置信息，对解析任务进行拆分，分配出task。
+
+{% endhint %}
+
+**消息路由**主要用于不同地域之间消息的同步，保证地域之间的数据一致性和复制备份。RocketMQ的消息路由特性打通了多个集群之间的消息互通，高效地实现了分布在不同地域之间的RocketMQ集群的消息同步复制
+
+![Messaging Connector &#x67B6;&#x6784;&#x56FE;](.gitbook/assets/image.png)
+
+### 消息路由（Message Connector）的几个概念：
+
+ 简单理解**Message Connector**就是借RocketMQ、kafka等从某个系统获取数据，借助消费消息写入到其他系统。**主要由Source Connector，Sink Connector、Runtime组成。**
+
+ **Source Connector**负责从其它系统获取数据。
+
+ **Sink Connector**负责从Producer中消费消息，将数据写入到另外的系统。
+
+ **Runtime**是Source ，Sink connector的运行时环境，负责加载Connector，提供RESTful接口，启动Connector任务，集群节点之间服务发现，配置同步，消费进度保存，故障转移，负载均衡等能力。
+
+**OpenMessaging** 是一套消息中间件领域的规范。**OpenMessaging Connect是Connect方面的api**，OpenMessaging 还有其他各种消息中间件邻域的规范，例如mq客户端规范，存储规范，实现OpenMessaging 规范可以做到厂商无关。**具体的Connector可以基于这套规范实现**。  
+
+
+#### RocketMQ Connector的几个概念：
+
+![RocketMQ Connect &#x603B;&#x89C8;](.gitbook/assets/rocketmq-connect-overview-3.png)
+
+简单理解RocketMQ Connect就是借RocketMQ从其他系统获取数据发送到RocketMQ，然后从RocketMQ消费消息写入到其他系统。主要由**Source Connector，Sink Connector，Runtime**组成。
+
+**Source Connector**负责从其它系统获取数据，通过Producer发送到到RocketMQ。
+
+**Sink Connector负**责从Producer中消费消息，将数据写入到另外的系统
 
 Review comment:
   ```suggestion
   **Sink Connector** 负责从Producer中消费消息，将数据写入到另外的系统
   ```
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403721468
 
 

 ##########
 File path: docs/cn/GitBook/connector/replicator/rocketmq-replicator.md
 ##########
 @@ -0,0 +1,135 @@
+---
+description: Replicator快速开始
+---
+
+# Replicator快速开始
+
+## RocketMQ Replicator Quick Start
+
+### 环境依赖
+
+1. **64bit JDK 1.8+;**
+2. **Maven 3.2.x或以上版本;**
+3. **Git**
+4. **RocketMQ集群环境;**
+
+### 项目下载
+
+```bash
+$ git clone https://github.com/apache/rocketmq-externals.git
+```
+
+### 项目构建
+
+```bash
+$ cd rocketmq-externals/rocketmq-replicator
+$ mvn clean install -Prelease-all -DskipTest -U
+
+### 出现如下信息，项目构建成功
+ 
+
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  14.432 s
+[INFO] Finished at: 2019-10-11T14:08:41+08:00
+[INFO] ------------------------------------------------------------------------
+```
+
+### 项目部署使用
+
+打包成功后将`rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar`（fatjar）放到`runtime`配置的`pluginPaths`目录下
+
+```bash
+$ cd target
+# 拷贝jar包到RocketMQ Runtime插件文件夹
+$ cp rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar /usr/local/connectors-plugin/
+```
+
+{% hint style="warning" %}
+**RocketMQ Runtime插件文件路径可配置，需要和Runtime参数中的插件路径配置相对应。**
+
+注：[Runtime 插件路径配置](../../rocketmq-connect-1/rocketmq-runtime/runtime-can-shu-pei-zhi.md#runtime-pei-zhi-can-shu-shuo-ming)
+{% endhint %}
+
+### 启动
+
+
+
+发送GET请求，启动rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${rocketmq-replicator-name}
+ ?config={
+ "connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+ "source-rocketmq":"xxxx:9876",
+ "target-rocketmq":"xxxxxxx:9876",
+ "replicator-store-topic":"replicatorTopic",
+ "taskDivideStrategy":"0",
+ "white-list":"TopicTest,TopicTest2",
+ target-cluster":"{RocketMQCluster-Target}",
 
 Review comment:
   ```suggestion
   "target-cluster":"{RocketMQCluster-Target}",
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403762940
 
 

 ##########
 File path: docs/cn/GitBook/connector/replicator/rocketmq-replicator.md
 ##########
 @@ -0,0 +1,135 @@
+---
+description: Replicator快速开始
+---
+
+# Replicator快速开始
+
+## RocketMQ Replicator Quick Start
+
+### 环境依赖
+
+1. **64bit JDK 1.8+;**
+2. **Maven 3.2.x或以上版本;**
+3. **Git**
+4. **RocketMQ集群环境;**
+
+### 项目下载
+
+```bash
+$ git clone https://github.com/apache/rocketmq-externals.git
+```
+
+### 项目构建
+
+```bash
+$ cd rocketmq-externals/rocketmq-replicator
+$ mvn clean install -Prelease-all -DskipTest -U
+
+### 出现如下信息，项目构建成功
+ 
+
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  14.432 s
+[INFO] Finished at: 2019-10-11T14:08:41+08:00
+[INFO] ------------------------------------------------------------------------
+```
+
+### 项目部署使用
+
+打包成功后将`rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar`（fatjar）放到`runtime`配置的`pluginPaths`目录下
+
+```bash
+$ cd target
+# 拷贝jar包到RocketMQ Runtime插件文件夹
+$ cp rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar /usr/local/connectors-plugin/
+```
+
+{% hint style="warning" %}
+**RocketMQ Runtime插件文件路径可配置，需要和Runtime参数中的插件路径配置相对应。**
+
+注：[Runtime 插件路径配置](../../rocketmq-connect-1/rocketmq-runtime/runtime-can-shu-pei-zhi.md#runtime-pei-zhi-can-shu-shuo-ming)
 
 Review comment:
   link is incorrect

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403715137
 
 

 ##########
 File path: docs/cn/GitBook/README.md
 ##########
 @@ -0,0 +1,76 @@
+---
+description: Message Connector相关概念简介
+---
+
+# Message Connector 简介
+
+### 消息路由（Message Connector）是什么？
+
+{% hint style="success" %}
+
+**Connector的定义**
+
+连接器实例属于逻辑概念，其负责维护特定数据系统的相关配置，比如链接地址、需要同步哪些数据等信息；在connector实例被启动后，connector可以根据配置信息，对解析任务进行拆分，分配出task。
+
+{% endhint %}
+
+**消息路由**主要用于不同地域之间消息的同步，保证地域之间的数据一致性和复制备份。RocketMQ的消息路由特性打通了多个集群之间的消息互通，高效地实现了分布在不同地域之间的RocketMQ集群的消息同步复制
+
+![Messaging Connector &#x67B6;&#x6784;&#x56FE;](.gitbook/assets/image.png)
+
+### 消息路由（Message Connector）的几个概念：
+
+ 简单理解**Message Connector**就是借RocketMQ、kafka等从某个系统获取数据，借助消费消息写入到其他系统。**主要由Source Connector，Sink Connector、Runtime组成。**
+
+ **Source Connector**负责从其它系统获取数据。
+
+ **Sink Connector**负责从Producer中消费消息，将数据写入到另外的系统。
+
+ **Runtime**是Source ，Sink connector的运行时环境，负责加载Connector，提供RESTful接口，启动Connector任务，集群节点之间服务发现，配置同步，消费进度保存，故障转移，负载均衡等能力。
+
+**OpenMessaging** 是一套消息中间件领域的规范。**OpenMessaging Connect是Connect方面的api**，OpenMessaging 还有其他各种消息中间件邻域的规范，例如mq客户端规范，存储规范，实现OpenMessaging 规范可以做到厂商无关。**具体的Connector可以基于这套规范实现**。  
+
+
+#### RocketMQ Connector的几个概念：
+
+![RocketMQ Connect &#x603B;&#x89C8;](.gitbook/assets/rocketmq-connect-overview-3.png)
+
+简单理解RocketMQ Connect就是借RocketMQ从其他系统获取数据发送到RocketMQ，然后从RocketMQ消费消息写入到其他系统。主要由**Source Connector，Sink Connector，Runtime**组成。
+
+**Source Connector**负责从其它系统获取数据，通过Producer发送到到RocketMQ。
+
+**Sink Connector负**责从Producer中消费消息，将数据写入到另外的系统
 
 Review comment:
   ```suggestion
   **Sink Connector**负责从Producer中消费消息，将数据写入到另外的系统
   ```
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] duhenglucky merged pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

duhenglucky merged pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] ClementIV commented on issue #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

ClementIV commented on issue #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#issuecomment-609427796
 
 
   @duhenglucky 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] ClementIV commented on issue #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

ClementIV commented on issue #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#issuecomment-609539978
 
 
   @gripson thx ! 😊 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [rocketmq-externals] gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code

Posted by GitBox <gi...@apache.org>.

gripson commented on a change in pull request #548: docs(connect): upload gitbook markdown code
URL: https://github.com/apache/rocketmq-externals/pull/548#discussion_r403762835
 
 

 ##########
 File path: docs/cn/GitBook/connector/replicator/rocketmq-replicator.md
 ##########
 @@ -0,0 +1,135 @@
+---
+description: Replicator快速开始
+---
+
+# Replicator快速开始
+
+## RocketMQ Replicator Quick Start
+
+### 环境依赖
+
+1. **64bit JDK 1.8+;**
+2. **Maven 3.2.x或以上版本;**
+3. **Git**
+4. **RocketMQ集群环境;**
+
+### 项目下载
+
+```bash
+$ git clone https://github.com/apache/rocketmq-externals.git
+```
+
+### 项目构建
+
+```bash
+$ cd rocketmq-externals/rocketmq-replicator
+$ mvn clean install -Prelease-all -DskipTest -U
+
+### 出现如下信息，项目构建成功
+ 
+
+...
+[INFO] ------------------------------------------------------------------------
+[INFO] BUILD SUCCESS
+[INFO] ------------------------------------------------------------------------
+[INFO] Total time:  14.432 s
+[INFO] Finished at: 2019-10-11T14:08:41+08:00
+[INFO] ------------------------------------------------------------------------
+```
+
+### 项目部署使用
+
+打包成功后将`rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar`（fatjar）放到`runtime`配置的`pluginPaths`目录下
+
+```bash
+$ cd target
+# 拷贝jar包到RocketMQ Runtime插件文件夹
+$ cp rocketmq-replicator-0.1.0-SNAPSHOT-jar-with-dependencies.jar /usr/local/connectors-plugin/
+```
+
+{% hint style="warning" %}
+**RocketMQ Runtime插件文件路径可配置，需要和Runtime参数中的插件路径配置相对应。**
+
+注：[Runtime 插件路径配置](../../rocketmq-connect-1/rocketmq-runtime/runtime-can-shu-pei-zhi.md#runtime-pei-zhi-can-shu-shuo-ming)
+{% endhint %}
+
+### 启动
+
+
+
+发送GET请求，启动rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${rocketmq-replicator-name}
+ ?config={
+ "connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+ "source-rocketmq":"xxxx:9876",
+ "target-rocketmq":"xxxxxxx:9876",
+ "replicator-store-topic":"replicatorTopic",
+ "taskDivideStrategy":"0",
+ "white-list":"TopicTest,TopicTest2",
+ target-cluster":"{RocketMQCluster-Target}",
+"source-cluster":"{RocketMQCluster-Source}",
+ "task-parallelism":"2",
+ "source-record-converter":"org.apache.rocketmq.connect.runtime.converter.JsonConverter"
+ }
+```
+
+* [参数说明文档](replicator-can-shu-pei-zhi.md)
+* 启动实例
+
+```http
+http://localhost:8081/connectors/replicator-test?config={
+"connector-class":"org.apache.rocketmq.replicator.RmqSourceReplicator",
+"source-rocketmq":"xxx.xxx.xxx.xxx:9876",
+"target-rocketmq":"xxx.xxx.xxx.xxx:9876",
+"replicator-store-topic":"replicatorTopic",
+"taskDivideStrategy":"0",
+"white-list":"fileTopic",
+"task-parallelism":"4",
+"target-cluster":"RocketMQCluster-xxx",
+"source-cluster":"RocketMQCluster-xxx",
+"source-record-converter":"org.apache.rocketmq.connect.runtime.converter.JsonConverter",
+"topic.rename.format":"rename-${topic}"
+}
+```
+
+{% hint style="info" %}
+* 上述namesrv地址需要换成自己的地址
+* 参数'replicator-store-topic' 的topic要先在runtime集群创建
+* 集群名称要替换成对应的集群名称
+{% endhint %}
+
+### 启动前确认
+
+{% hint style="info" %}
+请确认启动参数中**replicator-store-topic**和**white-list**的topic已经在**Source集群**创建
+
+[Topic创建文档](https://rocketmq-1.gitbook.io/rocketmq-connector/quick-start/rocketmq-runtime-shi-yong#chuang-jian-topic)
+{% endhint %}
+
+### 停止
+
+发送GET请求，停止rocketmq-replicator
+
+* 请求模板
+
+```http
+http://${runtime-ip}:${runtime-port}/connectors/${replicator-name}/stop
+```
+
+* 停止示例
+
+```http
+http://localhost:8081/connectors/replicator-test/stop
+```
+
+{% hint style="info" %}
+更多参数设置说明与Connector操作请参考 
+
+* [replicator配置参数说明](replicator-can-shu-pei-zhi.md)
 
 Review comment:
   link is incorrect

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services