-
Notifications
You must be signed in to change notification settings - Fork 45
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ISSUE #166] Provide updated Runtime/Docker deployment and compilatio…
…n docs (#170) * Format updated connectors doc * Remove zh incubator desc * fix zh next 1.10.0 release notes * Sync connectors change * migrate connector status * Split connectors table * Sync connector doc, order by roadmap * add link to doc in roadmap * fix minor issues * use new http connector doc * provide runtime docker deployment and compilation doc * provide runtime deployment and compilation doc * minor optimization * fix broken links * fix broken anchors and some minor issue * Make less important Eclipse documentation less prominent * copy Next docs to v1.10.0 & add sidebar & fix relative path * Add the Event Store Implementation Status * some minor change * link to Event Store instead of Github * add non-standalone notice * add code block highlight * upgrade docusaurus from 2.4.1 to 2.4.3 and node from 16 to 18 * Update outdated info of Runtime docs
- Loading branch information
Showing
179 changed files
with
3,894 additions
and
2,538 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Redis | ||
|
|
||
| ## RedisSinkConnector: From EventMesh to Redis topic queue | ||
|
|
||
| 1. start your Redis instance if needed and EventMesh Runtime. | ||
| 2. enable sinkConnector and check `sink-config.yml`. | ||
| 3. start your `RedisConnectServer`, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.topic` in your Redis. | ||
| 4. send a message to EventMesh with the topic defined in `pubSubConfig.subject` and then you will receive the message in Redis. | ||
|
|
||
| ```yaml | ||
| pubSubConfig: | ||
| # default port 10000 | ||
| meshAddress: your.eventmesh.server:10000 | ||
| subject: TopicTest | ||
| idc: FT | ||
| env: PRD | ||
| group: redisSink | ||
| appId: 5031 | ||
| userName: redisSinkUser | ||
| passWord: redisPassWord | ||
| connectorConfig: | ||
| connectorName: redisSink | ||
| server: redis://127.0.0.1:6379 | ||
| # the topic in redis | ||
| topic: SinkTopic | ||
| ``` | ||
| ## RedisSourceConnector: From Redis topic queue to EventMesh | ||
| 1. start your Redis instance if needed and EventMesh Runtime. | ||
| 2. enable sourceConnector and check `source-config.yml` (Basically the same as `sink-config.yml`) | ||
| 3. start your `RedisConnectServer`, it will subscribe to the topic defined in `connectorConfig.topic` in your Redis and send data to `pubSubConfig.subject` of EventMesh Runtime. | ||
| 4. send a CloudEvent message to the topic in Redis, and you will receive the message in EventMesh. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # MongoDB | ||
|
|
||
| ## MongoDBSinkConnector: From EventMesh to MongoDB | ||
|
|
||
| 1. launch your MongoDB server and EventMesh Runtime. | ||
| 2. enable sinkConnector and check `sink-config.yml`. | ||
| 3. start your MongoDBConnectorServer, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.collection` in your MongoDB. | ||
| 4. send a message to EventMesh with the topic defined in `pubSubConfig.subject` and then you will receive the message in MongoDB. | ||
|
|
||
| ```yaml | ||
| pubSubConfig: | ||
| # default port 10000 | ||
| meshAddress: your.eventmesh.server:10000 | ||
| subject: TopicTest | ||
| idc: FT | ||
| env: PRD | ||
| group: mongodbSink | ||
| appId: 5031 | ||
| userName: mongodbSinkUser | ||
| passWord: mongodbPassWord | ||
| connectorConfig: | ||
| connectorName: mongodbSink | ||
| # REPLICA_SET or STANDALONE is supported | ||
| connectorType: STANDALONE | ||
| # mongodb://root:[email protected]:27018,127.0.0.1:27019 | ||
| url: mongodb://127.0.0.1:27018 | ||
| database: yourDB | ||
| collection: yourCol | ||
| ``` | ||
| ## MongoDBSourceConnector: From MongoDB to EventMesh | ||
| 1. launch your MongoDB server and EventMesh Runtime. | ||
| 2. enable sourceConnector and check `source-config.yml` (Basically the same as `sink-config.yml`) | ||
| 3. start your `MongoDBSourceConnector`, it will subscribe to the collection defined in `connectorConfig.collection` in your MongoDB and send data to `pubSubConfig.subject` of EventMesh Runtime. | ||
| 4. write a CloudEvent message to `yourCol` at `yourDB` in your MongoDB and then you will receive the message in EventMesh. |
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # 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 10000 | ||
| meshAddress: your.eventmesh.server: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 | ||
| ``` | ||
| ### CloudEvent Attributes | ||
| When using the eventmesh-connector-dingtalk sinking event, you need to add the corresponding extension filed in CloudEvent: | ||
| - When key=`dingtalktemplatetype`, value=`text`/`markdown`, indicating the text type of the event. | ||
| - When text type is markdown, you can add extension: key=`dingtalkmarkdownmessagetitle`, value indicates the title of the event. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # WeCom | ||
|
|
||
| ## WecomSinkConnector: From EventMesh to WeCom | ||
|
|
||
| 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 10000 | ||
| meshAddress: your.eventmesh.server:10000 | ||
| subject: TEST-TOPIC-WECOM | ||
| idc: FT | ||
| env: PRD | ||
| group: weComSink | ||
| appId: 5034 | ||
| userName: weComSinkUser | ||
| passWord: weComPassWord | ||
| sinkConnectorConfig: | ||
| connectorName: weComSink | ||
| # Please refer to: https://developer.work.weixin.qq.com/document/path/90236 | ||
| robotWebhookKey: weComRobotWebhookKey | ||
| ``` | ||
| ### CloudEvent Attributes | ||
| When using the eventmesh-connector-wecom sinking event, you need to add the corresponding extension filed in CloudEvent: | ||
| - When key=`wecomtemplatetype`, value=`text`/`markdown`, indicating the text type of the event. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Slack | ||
|
|
||
| ## SlackSinkConnector: From EventMesh to Slack | ||
|
|
||
| 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 10000 | ||
| meshAddress: your.eventmesh.server:10000 | ||
| subject: TEST-TOPIC-SLACK | ||
| idc: FT | ||
| env: PRD | ||
| group: slackSink | ||
| appId: 5034 | ||
| userName: slackSinkUser | ||
| passWord: slackPassWord | ||
| sinkConnectorConfig: | ||
| connectorName: slackSink | ||
| # Please refer to: https://api.slack.com/messaging/sending | ||
| appToken: slackAppToken | ||
| channelId: slackChannelId | ||
| ``` |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.