This is an automated email from the ASF dual-hosted git repository.
mikexue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/eventmesh.git
The following commit(s) were added to refs/heads/master by this push:
new b85a58cc6 [ISSUE #4607] Documentation Needed for
eventmesh-connector-rabbitmq (#4641)
b85a58cc6 is described below
commit b85a58cc6efefbaf8554e9c9244b0595634a1200
Author: Fabian Bao <[email protected]>
AuthorDate: Thu Dec 14 15:30:52 2023 +0800
[ISSUE #4607] Documentation Needed for eventmesh-connector-rabbitmq (#4641)
* feat: Add doc for eventmesh-connector-rabbitmq
* feat: Add doc for eventmesh-connector-rabbitmq
---
.../eventmesh-connector-lark/README.md | 2 +-
.../eventmesh-connector-rabbitmq/README.md | 39 +++++++++++++++++++++
.../eventmesh-connector-rabbitmq/README_CN.md | 40 ++++++++++++++++++++++
3 files changed, 80 insertions(+), 1 deletion(-)
diff --git a/eventmesh-connectors/eventmesh-connector-lark/README.md
b/eventmesh-connectors/eventmesh-connector-lark/README.md
index 7f8d42218..1da30a13f 100644
--- a/eventmesh-connectors/eventmesh-connector-lark/README.md
+++ b/eventmesh-connectors/eventmesh-connector-lark/README.md
@@ -3,7 +3,7 @@
## Lark Sink Server Config And Start
Before using eventmesh-connector-lark to sink events, you need to configure
the server.
-- Please customize `sinkEnable``=`true`/`false` in
`/resource/server-config.yml` to turn on/off the sink function.
+- Please customize `sinkEnable`=`true`/`false` in
`/resource/server-config.yml` to turn on/off the sink function.
- Regarding `/resource/sink-config.yml`, only the configuration under
`sinkConnectorConfig` is explained here:
- `connectorName`, specify the connector name
- (required) `appId`, the appId obtained from lark
diff --git a/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md
b/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md
new file mode 100644
index 000000000..a8b338f16
--- /dev/null
+++ b/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md
@@ -0,0 +1,39 @@
+# eventmesh-connector-rabbitmq
+
+## RabbitMQSinkConnector: from eventmesh to rabbitmq.
+
+1. launch your rabbitmq server and eventmesh-runtime.
+2. enable sinkConnector and check `sink-config.yml`.
+3. send a message to eventmesh with the topic defined in `pubSubConfig.subject`
+```yaml
+pubSubConfig:
+ # default port is 10000
+ meshAddress: your.eventmesh.server:10000
+ subject: TopicTest
+ idc: FT
+ env: PRD
+ group: rabbitmqSink
+ appId: 5031
+ userName: rabbitmqSinkUser
+ passWord: rabbitmqPassWord
+connectorConfig:
+ connectorName: rabbitmqSink
+ host: your.rabbitmq.server
+ port: 5672
+ username: coyrqpyz
+ passwd: passwd
+ virtualHost: coyrqpyz
+ exchangeType: TOPIC
+ # build-in exchangeName or name a new one after you create it in rabbitmq
server.
+ exchangeName: amq.topic
+ # rabbitmq server will create the routingKey and queueName automatically
after you connect to it if they aren't exist before.
+ routingKey: eventmesh
+ queueName: eventmesh
+ autoAck: true
+```
+
+## RabbitMQSourceConnector: from rabbitmq to eventmesh.
+1. launch your rabbitmq server and eventmesh-runtime.
+2. enable sourceConnector and check `source-config.yml` (Basically the same as
`sink-config.yml`)
+3. start your `RabbitMQConnectorServer` and you will find the channel in
rabbitmq server.
+4. send a cloudevent message to the queue and then you will receive the
message in eventmesh.
\ No newline at end of file
diff --git a/eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md
b/eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md
new file mode 100644
index 000000000..df9f5a3ab
--- /dev/null
+++ b/eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md
@@ -0,0 +1,40 @@
+# eventmesh-connector-rabbitmq
+
+## RabbitMQSinkConnector：从 eventmesh 到 rabbitmq。
+
+1. 启动你的 rabbitmq 服务和 eventmesh-runtime。
+2. 启用 sinkConnector 并检查 `sink-config.yml`。
+3. 向 eventmesh 发送带有在 `pubSubConfig.subject` 中定义的主题消息。
+```yaml
+pubSubConfig:
+ # 默认端口 10000
+ meshAddress: your.eventmesh.server:10000
+ subject: TopicTest
+ idc: FT
+ env: PRD
+ group: rabbitmqSink
+ appId: 5031
+ userName: rabbitmqSinkUser
+ passWord: rabbitmqPassWord
+connectorConfig:
+ connectorName: rabbitmqSink
+ host: your.rabbitmq.server
+ port: 5672
+ username: coyrqpyz
+ passwd: passwd
+ virtualHost: coyrqpyz
+ exchangeType: TOPIC
+ # 使用内置的 exchangeName 或在连接到 rabbitmq 服务后创建新的 exchangeName。
+ exchangeName: amq.topic
+ # 如果在连接之前不存在，rabbitmq 服务将自动创建 routingKey 和 queueName。
+ routingKey: eventmesh
+ queueName: eventmesh
+ autoAck: true
+```
+
+## RabbitMQSourceConnector：从 rabbitmq 到 eventmesh。
+
+1. 启动你的 rabbitmq 服务器和 eventmesh-runtime。
+2. 启用 sourceConnector 并检查 `source-config.yml`（与 sink-config.yml 基本相同）。
+3. 启动你的 RabbitMQConnectorServer，你会在 rabbitmq 服务中找到该channel。
+4. 向队列发送一个 cloudevent 消息，然后你将在 eventmesh 中接收到该消息。
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
