Skip to content

Commit

Permalink
[ISSUE #4658] Add documentation for dingtalk sink connector. (#4660)
Browse files Browse the repository at this point in the history
* Add documentation for dingtalk sink connector.

* fix
  • Loading branch information
yanrongzhen authored Dec 16, 2023
1 parent be8fcc9 commit 61e1392
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 9 deletions.
26 changes: 26 additions & 0 deletions eventmesh-connectors/eventmesh-connector-dingtalk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# eventmesh-connector-dingtalk

## DingtalkSinkConnector:from eventmesh to dingtalk。

1. launch your 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: 127.0.0.1:10000
subject: TEST-TOPIC-DINGTALK
idc: FT
env: PRD
group: dingTalkSink
appId: 5034
userName: dingTalkSinkUser
passWord: dingTalkPassWord
sinkConnectorConfig:
connectorName: dingTalkSink
# Please refer to: https://open.dingtalk.com/document/orgapp/the-robot-sends-a-group-message
appKey: dingTalkAppKey
appSecret: dingTalkAppSecret
openConversationId: dingTalkOpenConversationId
robotCode: dingTalkRobotCode
```
26 changes: 26 additions & 0 deletions eventmesh-connectors/eventmesh-connector-dingtalk/README_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# eventmesh-connector-dingtalk

## DingtalkSinkConnector:从 eventmesh 到 dingtalk。

1. 启动你的 eventmesh-runtime。
2. 启用 sinkConnector 并检查 `sink-config.yml`
3. 向 eventmesh 发送带有在 `pubSubConfig.subject` 中定义的主题消息。
```yaml
pubSubConfig:
# 默认端口10000
meshAddress: 127.0.0.1:10000
subject: TEST-TOPIC-DINGTALK
idc: FT
env: PRD
group: dingTalkSink
appId: 5034
userName: dingTalkSinkUser
passWord: dingTalkPassWord
sinkConnectorConfig:
connectorName: dingTalkSink
# 以下配置参考 https://open.dingtalk.com/document/orgapp/the-robot-sends-a-group-message
appKey: dingTalkAppKey
appSecret: dingTalkAppSecret
openConversationId: dingTalkOpenConversationId
robotCode: dingTalkRobotCode
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@

pubSubConfig:
meshAddress: 127.0.0.1:10000
subject: TEST-TOPIC-DINGDING
subject: TEST-TOPIC-DINGTALK
idc: FT
env: PRD
group: dingDingSink
group: dingTalkSink
appId: 5034
userName: dingDingSinkUser
passWord: dingDingPassWord
userName: dingTalkSinkUser
passWord: dingTalkPassWord
sinkConnectorConfig:
connectorName: dingDingSink
appKey: dingDingAppKey
appSecret: dingDingAppSecret
openConversationId: dingDingOpenConversationId
robotCode: dingDingRobotCode
connectorName: dingTalkSink
appKey: dingTalkAppKey
appSecret: dingTalkAppSecret
openConversationId: dingTalkOpenConversationId
robotCode: dingTalkRobotCode

0 comments on commit 61e1392

Please sign in to comment.