From 73ab1d6a2c545d5ed15421c464646bb02e07b721 Mon Sep 17 00:00:00 2001 From: Pil0tXia Date: Wed, 24 Jan 2024 19:06:03 +0800 Subject: [PATCH] [ISSUE #4725] Update issue template and remove deprecated connector docs (#4726) * Update issue template and enable code block rendering * Remove deprecated docs --- .github/ISSUE_TEMPLATE/bug_report.yml | 6 ++ .github/PULL_REQUEST_TEMPLATE.md | 2 +- eventmesh-connectors/README.md | 81 ------------------- eventmesh-connectors/README_CN.md | 81 ------------------- .../eventmesh-connector-dingtalk/README.md | 34 -------- .../eventmesh-connector-dingtalk/README_CN.md | 34 -------- .../eventmesh-connector-http/README.md | 67 --------------- .../eventmesh-connector-http/README_CN.md | 67 --------------- .../eventmesh-connector-lark/README.md | 36 --------- .../eventmesh-connector-lark/README_CN.md | 36 --------- .../eventmesh-connector-mongodb/README.md | 36 --------- .../eventmesh-connector-mongodb/README_CN.md | 36 --------- .../eventmesh-connector-rabbitmq/README.md | 42 ---------- .../eventmesh-connector-rabbitmq/README_CN.md | 42 ---------- .../eventmesh-connector-redis/README.md | 33 -------- .../eventmesh-connector-redis/README_CN.md | 33 -------- .../eventmesh-connector-slack/README.md | 25 ------ .../eventmesh-connector-slack/README_CN.md | 25 ------ .../eventmesh-connector-wecom/README.md | 30 ------- .../eventmesh-connector-wecom/README_CN.md | 30 ------- 20 files changed, 7 insertions(+), 769 deletions(-) delete mode 100644 eventmesh-connectors/README.md delete mode 100644 eventmesh-connectors/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-dingtalk/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-dingtalk/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-http/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-http/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-lark/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-lark/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-mongodb/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-mongodb/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-rabbitmq/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-redis/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-redis/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-slack/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-slack/README_CN.md delete mode 100644 eventmesh-connectors/eventmesh-connector-wecom/README.md delete mode 100644 eventmesh-connectors/eventmesh-connector-wecom/README_CN.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 0df61516c8..a19b99ed3d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -55,6 +55,11 @@ body: description: Describe the EventMesh version. options: - master + - 1.10.0 + - 1.9.0 + - 1.8.0 + - 1.7.0 + - 1.6.0 - 1.5.0 - 1.4.0 - 1.3.0 @@ -89,6 +94,7 @@ body: description: Anything else we need to know? placeholder: > Add your debug logs here. + render: Java validations: required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 3ffc732e0e..428cda5f55 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -23,7 +23,7 @@ (If this PR fixes a GitHub issue, please add `Fixes #` or `Closes #`.) --> -Fixes #. +Fixes #issue_id ### Motivation diff --git a/eventmesh-connectors/README.md b/eventmesh-connectors/README.md deleted file mode 100644 index 32c9765803..0000000000 --- a/eventmesh-connectors/README.md +++ /dev/null @@ -1,81 +0,0 @@ -# Connectors - -## Connector - -A connector is an image or instance that interacts with a specific external service or underlying data source (e.g., Databases) on behalf of user applications. A connector is either a Source or a Sink. - -Connector runs as a standalone service by `main()`. - -## Source - -A source connector obtains data from an underlying data producer, and delivers it to targets after original data has been transformed into CloudEvents. It doesn't limit the way how a source retrieves data. (e.g., A source may pull data from a message queue or act as an HTTP server waiting for data sent to it). - -## Sink - -A sink connector receives CloudEvents and does some specific business logics. (e.g., A MySQL Sink extracts useful data from CloudEvents and writes them to a MySQL database). - -## CloudEvents - -A specification for describing event data in common formats to provide interoperability across services, platforms and systems. - -## Implements - -Add a new connector by implementing the source/sink interface using [eventmesh-openconnect-java](https://github.com/apache/eventmesh/tree/master/eventmesh-openconnect/eventmesh-openconnect-java). - -## Technical Solution - -### Structure and process - -![source-sink connector architecture](https://raw.githubusercontent.com/apache/eventmesh-site/master/static/images/design-document/connector-architecture.png) - -### Design Detail - -![eventmesh-connect-detail](https://raw.githubusercontent.com/apache/eventmesh-site/master/static/images/design-document/connector-design-detail.png) - -### Description - -#### Worker - -Worker is divided into Source Worker and Sink Worker, which are triggered by the `Application` class and implement the methods of the `ConnectorWorker` interface respectively, which include the worker's running life cycle, and the worker carries the running of the connector. Workers can be lightweight and independent through mirroring Running, the eventmesh-sdk-java module is integrated internally, and the CloudEvents protocol is used to interact with EventMesh. Currently, the TCP client is used by default. In the future, support for dynamic configuration can be considered. - -#### Connector - -Connectors are divided into Source Connector and Sink Connector. Connectors have their own configuration files and run independently. Workers perform reflective loading and configuration analysis to complete Connector initialization and subsequent operation. Source Connector implements the poll method, and Sink Connector implements The put method uniformly uses `ConnectorRecord` to carry data. Both Source Connector and Sink Connector can operate independently. - -#### ConnectorRecord with CloudEvents - -`ConnectorRecord` is a connector layer data protocol. When workers interact with EventMesh, a protocol adapter needs to be developed to convert `ConnectorRecord` to CloudEvents protocol. - -#### Registry - -The Registry module is responsible for storing the synchronization progress of synchronizing data of different Connector instances, ensuring high availability between multiple Connector images or instances. - -## Connector Status - -| Connector Name | Source | Sink | -|:------------------------------------------------:|:-----------:|:-------:| -| [RocketMQ](eventmesh-connector-rocketmq) | ✅ | ✅ | -| ChatGPT | ⬜ | ⬜ | -| ClickHouse | ⬜ | ⬜ | -| [DingTalk](eventmesh-connector-dingtalk) | ⬜ | ✅ | -| Email | ⬜ | ⬜ | -| [Feishu/Lark](eventmesh-connector-lark) | ⬜ | ✅ | -| [File](eventmesh-connector-file) | ✅ | ✅ | -| GitHub | ⬜ | ⬜ | -| [HTTP](eventmesh-connector-http) | ✅ | ⬜ | -| [Jdbc](eventmesh-connector-jdbc) | ⬜ | ✅ | -| [Kafka](eventmesh-connector-kafka) | ✅ | ✅ | -| [Knative](eventmesh-connector-knative) | ✅ | ✅ | -| [MongoDB](eventmesh-connector-mongodb) | ✅ | ✅ | -| [OpenFunction](eventmesh-connector-openfunction) | ✅ | ✅ | -| [Pravega](eventmesh-connector-pravega) | ✅ | ✅ | -| [Prometheus](eventmesh-connector-prometheus) | ✅ | ⬜ | -| [Pulsar](eventmesh-connector-pulsar) | ✅ | ✅ | -| [RabbitMQ](eventmesh-connector-rabbitmq) | ✅ | ✅ | -| [Redis](eventmesh-connector-redis) | ✅ | ✅ | -| [S3 File](eventmesh-connector-s3) | ⬜ | ✅ | -| [Slack](eventmesh-connector-slack) | ⬜ | ✅ | -| [Spring](eventmesh-connector-spring) | ✅ | ✅ | -| [WeCom](eventmesh-connector-wecom) | ⬜ | ✅ | -| [WeChat](eventmesh-connector-wechat) | ⬜ | ✅ | -| More connectors will be added... | N/A | N/A | diff --git a/eventmesh-connectors/README_CN.md b/eventmesh-connectors/README_CN.md deleted file mode 100644 index be78a6a3e6..0000000000 --- a/eventmesh-connectors/README_CN.md +++ /dev/null @@ -1,81 +0,0 @@ -# 连接器简介 - -## 连接器类型 - -连接器是代表用户应用程序与特定外部服务或底层数据源（例如数据库）交互的镜像或实例。连接器的类型可以是源（Source）或汇（Sink）。 - -连接器通过 `main()` 作为一个独立服务运行。 - -## 数据源（Source 端） - -源连接器从底层数据生产者获取数据，并在原始数据被转换为 CloudEvents 后将其传递给目标。源连接器不限制源如何检索数据（例如，源可以从消息队列中获取数据，也可以充当等待接收数据的 HTTP 服务器）。 - -## 数据汇（Sink 端） - -汇连接器接收 CloudEvents 并执行特定的业务逻辑（例如，MySQL 的汇连接器从 CloudEvents 中提取有用的数据，并将其写入 MySQL 数据库）。 - -## CloudEvents - -CloudEvents 是一种以通用格式描述事件数据的规范，以提供服务、平台和系统之间的互操作性。 - -## 实现连接器 - -使用 [eventmesh-openconnect-java](https://github.com/apache/eventmesh/tree/master/eventmesh-openconnect/eventmesh-openconnect-java) 实现 Source/Sink 接口即可添加新的连接器。 - -## 技术方案 - -### 结构与处理流程 - -![source-sink connector architecture](https://raw.githubusercontent.com/apache/eventmesh-site/master/static/images/design-document/connector-architecture.png) - -### 详细设计 - -![eventmesh-connect-detail](https://raw.githubusercontent.com/apache/eventmesh-site/master/static/images/design-document/connector-design-detail.png) - -### 描述 - -#### Worker - -Worker 分为 Source Worker 与 Sink Worker，由`Application`类进行触发运行，分别实现了`ConnectorWorker`接口的方法，其中包含了 worker 的运行生命周期，worker 承载了 connector 的运行。Worker 可以通过镜像的方式轻量的独立运行，内部集成了 eventmesh-sdk-java 模块，采用 CloudEvents 协议与 EventMesh 进行交互，目前默认采用 TCP 客户端，后续可以考虑支持动态可配。 - -#### Connector - -Connector 分为 Source Connector 与 Sink Connector，connector 有各自的配置文件，以及独立运行的方式，通过 worker 进行反射加载与配置解析，完成 Connector 的初始化以及后续运行工作，其中 Source Connector 实现 poll 方法，Sink Connector 实现 put 方法，统一使用`ConnectorRecord`承载数据。Source Connector 与 Sink Connector 均可独立运行。 - -#### ConnectorRecord with CloudEvents - -`ConnectorRecord`为 connector 层数据协议，当 worker 与 EventMesh 进行交互时需开发协议适配器进行`ConnectorRecord`到 CloudEvents 的协议转换。 - -#### Registry - -`Registry`模块负责存储同步不同 Connector 实例的数据的同步进度，确保多个 Connector 镜像或实例之间的高可用。 - -## 连接器实现状态 - -| 连接器名称 | 源 | 汇 | -|:------------------------------------------------:|:-----------:|:-------:| -| [RocketMQ](eventmesh-connector-rocketmq) | ✅ | ✅ | -| ChatGPT | ⬜ | ⬜ | -| ClickHouse | ⬜ | ⬜ | -| [钉钉](eventmesh-connector-dingtalk) | ⬜ | ✅ | -| Email | ⬜ | ⬜ | -| [飞书/Lark](eventmesh-connector-lark) | ⬜ | ✅ | -| [文件](eventmesh-connector-file) | ✅ | ✅ | -| GitHub | ⬜ | ⬜ | -| [HTTP](eventmesh-connector-http) | ✅ | ⬜ | -| [Jdbc](eventmesh-connector-jdbc) | ⬜ | ✅ | -| [Kafka](eventmesh-connector-kafka) | ✅ | ✅ | -| [Knative](eventmesh-connector-knative) | ✅ | ✅ | -| [MongoDB](eventmesh-connector-mongodb) | ✅ | ✅ | -| [OpenFunction](eventmesh-connector-openfunction) | ✅ | ✅ | -| [Pravega](eventmesh-connector-pravega) | ✅ | ✅ | -| [Prometheus](eventmesh-connector-prometheus) | ✅ | ⬜ | -| [Pulsar](eventmesh-connector-pulsar) | ✅ | ✅ | -| [RabbitMQ](eventmesh-connector-rabbitmq) | ✅ | ✅ | -| [Redis](eventmesh-connector-redis) | ✅ | ✅ | -| [S3 存储](eventmesh-connector-s3) | ⬜ | ✅ | -| [Slack](eventmesh-connector-slack) | ⬜ | ✅ | -| [Spring](eventmesh-connector-spring) | ✅ | ✅ | -| [企业微信](eventmesh-connector-wecom) | ⬜ | ✅ | -| [微信](eventmesh-connector-wechat) | ⬜ | ✅ | -| 更多连接器正在计划中... | N/A | N/A | diff --git a/eventmesh-connectors/eventmesh-connector-dingtalk/README.md b/eventmesh-connectors/eventmesh-connector-dingtalk/README.md deleted file mode 100644 index 4e3b729a11..0000000000 --- a/eventmesh-connectors/eventmesh-connector-dingtalk/README.md +++ /dev/null @@ -1,34 +0,0 @@ -# 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. \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-dingtalk/README_CN.md b/eventmesh-connectors/eventmesh-connector-dingtalk/README_CN.md deleted file mode 100644 index 1228a9ea29..0000000000 --- a/eventmesh-connectors/eventmesh-connector-dingtalk/README_CN.md +++ /dev/null @@ -1,34 +0,0 @@ -# 钉钉 - -## DingtalkSinkConnector：从 EventMesh 到钉钉 - -1. 启动你的 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息。 - -```yaml -pubSubConfig: - # 默认端口 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 - # 以下配置参考 https://open.dingtalk.com/document/orgapp/the-robot-sends-a-group-message - appKey: dingTalkAppKey - appSecret: dingTalkAppSecret - openConversationId: dingTalkOpenConversationId - robotCode: dingTalkRobotCode -``` - -### CloudEvent 属性 - -使用 eventmesh-connector-dingtalk 下沉事件时，需要在 CloudEvent 中添加对应的 extension filed： - -- 当 key=`dingtalktemplatetype`时，value=`text`/`markdown`，表明该事件的文本类型。 -- 当文本类型 `dingtalktemplatetype` 为 markdown 时，可以为文本设置标题。添加 extension：key=`dingtalkmarkdownmessagetitle`，value 为该事件的标题。 \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-http/README.md b/eventmesh-connectors/eventmesh-connector-http/README.md deleted file mode 100644 index 7572c4e5d6..0000000000 --- a/eventmesh-connectors/eventmesh-connector-http/README.md +++ /dev/null @@ -1,67 +0,0 @@ -# HTTP - -## 1 HTTP Source Connector - -### 1.1 Configuration - -Before using HTTP source connector, you need to configure the server. -- Please configure `sourceEnable` to `true` in `/resource/server-config.yml` to enable source functionality. -- Please configure the source connector in `/resource/source-config.yml`, only the configuration under `connectorConfig` is described here: - - `connectorName`, name of the connector. - - (required) `path`, path of the API. - - (required) `port`, port of the API. - - `idleTimeout`, idle TCP connection timeout in seconds. A connection will timeout and be closed if no data is received nor sent within the `idleTimeout` seconds. The default is 0, which means don't timeout. - -### 1.2 Startup - -1. start EventMesh Runtime -2. start eventmesh-connector-http - -When finished, the HTTP source connector will act as an HTTP server. - -### 1.3 Sending messages - -You can send messages to the source connector via HTTP. - -```yaml -connectorConfig: - connectorName: httpSource - path: /test - port: 3755 - idleTimeout: 5 -``` - -The above example configures a URL `http://localhost:3755/test` in `source-config.yml`. - -You can send messages in `binary` mode or `structured` mode as specified in [cloudevent-spec](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md). - -Here are two examples: - -1. Sending a message in `binary` mode. - -```shell -curl --location --request POST 'http://localhost:3755/test' \ ---header 'ce-id: 1' \ ---header 'ce-specversion: 1.0' \ ---header 'ce-type: com.example.someevent' \ ---header 'ce-source: /mycontext' \ ---header 'ce-subject: test_topic' \ ---header 'Content-Type: text/plain' \ ---data-raw 'testdata' -``` - -2. Sending a message in `structured` mode. - -```shell -curl --location --request POST 'http://localhost:3755/test' \ ---header 'Content-Type: application/cloudevents+json' \ ---data-raw '{ - "id": "1", - "specversion": "1.0", - "type": "com.example.someevent", - "source": "/mycontext", - "subject":"test_topic", - "datacontenttype":"text/plain", - "data": "testdata" -}' -``` diff --git a/eventmesh-connectors/eventmesh-connector-http/README_CN.md b/eventmesh-connectors/eventmesh-connector-http/README_CN.md deleted file mode 100644 index a2062c8867..0000000000 --- a/eventmesh-connectors/eventmesh-connector-http/README_CN.md +++ /dev/null @@ -1,67 +0,0 @@ -# HTTP - -## 1 HTTP Source Connector - -### 1.1 配置 - -使用 HTTP source connector 前，需要进行 server 的配置。 -- 请在 `/resource/server-config.yml` 中配置 `sourceEnable`为`true` 以开启 source 功能。 -- 请在 `/resource/source-config.yml`中配置 source connector, 在此仅说明 `connectorConfig` 下的配置： - - `connectorName`, connector 的名称 - - （必需） `path`, 接口的路径 - - （必需） `port`, 接口的端口 - - `idleTimeout`, 空闲 TCP 连接超时时间，单位为秒。超过 `idleTimeout` 秒没有进行数据接收或发送的连接将会发生超时并被关闭。默认为 0, 不会发生超时。 - -### 1.2 启动 - -1. 启动 EventMesh Runtime -2. 启动 eventmesh-connector-http - -完成后，HTTP source connector 会作为一个 HTTP 服务器对外提供服务。 - -### 1.3 发送消息 - -你可以通过 HTTP 向 source connector 发送消息。 - -```yaml -connectorConfig: - connectorName: httpSource - path: /test - port: 3755 - idleTimeout: 5 -``` - -上述的例子在`source-config.yml`中配置了一个 URL `http://localhost:3755/test`. - -你可以按照 [cloudevent-spec](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/bindings/http-protocol-binding.md) 中的规定，以`binary`模式或者`structured`模式发送消息。 - -这里是两个例子： - -以`binary`模式发送消息。 - -```shell -curl --location --request POST 'http://localhost:3755/test' \ ---header 'ce-id: 1' \ ---header 'ce-specversion: 1.0' \ ---header 'ce-type: com.example.someevent' \ ---header 'ce-source: /mycontext' \ ---header 'ce-subject: test_topic' \ ---header 'Content-Type: text/plain' \ ---data-raw 'testdata' -``` - -以`structured`模式发送消息。 - -```shell -curl --location --request POST 'http://localhost:3755/test' \ ---header 'Content-Type: application/cloudevents+json' \ ---data-raw '{ - "id": "1", - "specversion": "1.0", - "type": "com.example.someevent", - "source": "/mycontext", - "subject":"test_topic", - "datacontenttype":"text/plain", - "data": "testdata" -}' -``` \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-lark/README.md b/eventmesh-connectors/eventmesh-connector-lark/README.md deleted file mode 100644 index 665b590a45..0000000000 --- a/eventmesh-connectors/eventmesh-connector-lark/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# Feishu/Lark - -## 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. -- 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 - - (required) `appSecret`, the appSecret obtained from lark - - `receiveIdType`, the type of receiving Id, the default and recommended use is `open_id`. Optional open_id/user_id/union_id/email/chat_id. - - (Required) `receiveId`, receive Id, needs to correspond to `receiveIdType`. - - `sinkAsync`, whether to asynchronously sink events - - `maxRetryTimes`, the maximum number of retransmissions when the sink event fails. The default is 3 times. - - `retryDelayInMills`, when the sink event fails, the time interval for retransmitting the event. Default is 1s, unit is milliseconds. - -## Sink CloudEvent To Lark - -When using the eventmesh-connector-lark sinking event, you need to add the corresponding extension filed in CloudEvent: - -- When key=`templatetype4lark`, value=`text`/`markdown`, indicating the text type of the event. -- When text type is markdown, you can add extension: key=`markdownmessagetitle4lark`, value indicates the title of the event. -- When key=`atusers4lark`, value=`id-0,name-0;id-1,name-1`, indicating that the event requires `@`certain users. - - It is recommended to use **open_id** for id. - - When the text is of text type, the id can be **open_id/union_id/user_id**; when the text is of markdown type, the id can be **open_id/user_id**. In particular, when the application type is [custom robot](https://open.larksuite.com/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN) and the text is of markdown type, only the use of **open_id** to `@` the user is supported. - - When the text is of text type and the id is invalid, name will be used instead for display; when the text is of markdown type and the id is invalid, an exception will be thrown directly (you should try to ensure the correctness of the id, and name can be considered omitted). -- When key=`atall4lark`, value=`true`/`false`, indicating that the event requires `@` everyone. - -## Lark Open Platform API - -For the Lark open platform API involved in this module, please click the following link: - -- **Send Message**, please [view here](https://open.larksuite.com/document/server-docs/im-v1/message/create?appId=cli_a5e1bc31507ed00c) -- **text**, please [view here](https://open.larksuite.com/document/server-docs/im-v1/message-content-description/create_json#c9e08671) -- **markdown**, please [view here](https://open.larksuite.com/document/common-capabilities/message-card/message-cards-content/using-markdown-tags) \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-lark/README_CN.md b/eventmesh-connectors/eventmesh-connector-lark/README_CN.md deleted file mode 100644 index ce629335cf..0000000000 --- a/eventmesh-connectors/eventmesh-connector-lark/README_CN.md +++ /dev/null @@ -1,36 +0,0 @@ -# 飞书/Lark - -## Lark Sink Server 的配置与启动 - -使用 eventmesh-connector-lark 下沉事件之前，需要进行 server 的配置。 - -- 请在`/resource/server-config.yml`中自定义`sinkEnable`=`true`/`false`以开启/关闭 sink 功能。 -- 关于`/resource/sink-config.yml`，在此仅说明`sinkConnectorConfig`下的配置： - - `connectorName`, 指定 connector 名称 - - （必需）`appId`, lark 中获取的 appId - - （必需）`appSecret`, lark 中获取的 appSecret - - `receiveIdType`，接收 Id 的类型，默认且推荐使用`open_id`。可选 open_id/user_id/union_id/email/chat_id。 - - （必需）`receiveId`, 接收 Id，需要和`receiveIdType`对应。 - - `sinkAsync`, 是否异步下沉事件 - - `maxRetryTimes`, sink 事件失败时，最大重传的次数。默认 3 次。 - - `retryDelayInMills`, sink 事件失败时，重传事件的时间间隔。默认 1s，单位为毫秒。 - -## 可下沉飞书的 CLoudEvent - -使用 eventmesh-connector-lark 下沉事件时，需要在 CloudEvent 中添加对应的 extension filed： - -- 当 key=`templatetype4lark`时，value=`text`/`markdown`，表明该事件的文本类型。 -- 当文本类型 (`templatetype4lark`) 为 markdown 时，可以为文本设置标题。添加 extension：key=`markdownmessagetitle4lark`，value 为该事件的标题。 -- 当 key=`atusers4lark`时，value=`id-0,name-0;id-1,name-1`，表明该事件需要`@`某些用户。 - - id 推荐使用 **open_id**。 - - 当文本属于 text 类型时，id 可以是 **open_id/union_id/user_id**; 当文本属于 markdown 类型时，id 可以是 **open_id/user_id**。特别地，当应用类型为 [自定义机器人](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN) 且文本属于 markdown 类型，则仅支持使用 **open_id** 来`@`用户。 - - 当文本属于 text 类型且 id 无效时，将利用 name 代替展示；当文本属于 markdown 类型时且 id 无效时，直接抛出异常（您应该尽量保证 id 的正确性，而 name 则可以考虑省略）。 -- 当 key=`atall4lark`时，value=`true`/`false`，表明该事件需要`@`所有人。 - -## 飞书开放平台 API - -有关该模块涉及到的飞书开放平台 API，请点击以下链接： - -- **发送消息**，请 [查看这里](https://open.feishu.cn/document/server-docs/im-v1/message/create?appId=cli_a5e1bc31507ed00c) -- **text**，请 [查看这里](https://open.feishu.cn/document/server-docs/im-v1/message-content-description/create_json#c9e08671) -- **markdown**，请 [查看这里](https://open.feishu.cn/document/common-capabilities/message-card/message-cards-content/using-markdown-tags) \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-mongodb/README.md b/eventmesh-connectors/eventmesh-connector-mongodb/README.md deleted file mode 100644 index 4c4f8ac95c..0000000000 --- a/eventmesh-connectors/eventmesh-connector-mongodb/README.md +++ /dev/null @@ -1,36 +0,0 @@ -# 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:root@127.0.0.1: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. \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-mongodb/README_CN.md b/eventmesh-connectors/eventmesh-connector-mongodb/README_CN.md deleted file mode 100644 index 028fea6ba0..0000000000 --- a/eventmesh-connectors/eventmesh-connector-mongodb/README_CN.md +++ /dev/null @@ -1,36 +0,0 @@ -# MongoDB - -## MongoDBSinkConnector：从 EventMesh 到 MongoDB - -1. 启动你的 MongoDB 服务和 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 启动你的 MongoDBConnectorServer，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据发送到 MongoDB 中的 `connectorConfig.collection`。 -4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 MongoDB 中接收到该消息。 - -```yaml -pubSubConfig: - # 默认端口 10000 - meshAddress: your.eventmesh.server:10000 - subject: TopicTest - idc: FT - env: PRD - group: rabbitmqSink - appId: 5031 - userName: rabbitmqSinkUser - passWord: rabbitmqPassWord -connectorConfig: - connectorName: mongodbSink - # 支持 REPLICA_SET 和 STANDALONE - connectorType: STANDALONE - # mongodb://root:root@127.0.0.1:27018,127.0.0.1:27019 - url: mongodb://127.0.0.1:27018 - database: yourDB - collection: yourCol -``` - -## MongoDBSourceConnector：从 MongoDB 到 EventMesh - -1. 启动你的 MongoDB 服务和 EventMesh Runtime。 -2. 启用 sourceConnector 并检查 `source-config.yml`（与 sink-config.yml 基本相同）。 -3. 启动你的 MongoDBSourceConnector，它将订阅到 MongoDB 中的 `connectorConfig.collection`，并将数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject`。 -4. 向 MongoDB 中 `yourDB` 的 `yourCol` 写入一个 CloudEvent 消息，然后你将在 EventMesh 中接收到该消息。 \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md b/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md deleted file mode 100644 index 09d6643b37..0000000000 --- a/eventmesh-connectors/eventmesh-connector-rabbitmq/README.md +++ /dev/null @@ -1,42 +0,0 @@ -# RabbitMQ - -## RabbitMQSinkConnector: From EventMesh to RabbitMQ - -1. launch your RabbitMQ server and EventMesh Runtime. -2. enable sinkConnector and check `sink-config.yml`. -3. start your `RabbitMQConnectorServer`, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.queueName` in your RabbitMQ. -4. send a message to EventMesh with the topic defined in `pubSubConfig.subject` and then you will receive the message in RabbitMQ. - -```yaml -pubSubConfig: - # default port 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`, it will subscribe to the queue defined in `connectorConfig.queueName` in your RabbitMQ and send data to `pubSubConfig.subject` of EventMesh Runtime. -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 deleted file mode 100644 index b2c46aa68c..0000000000 --- a/eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md +++ /dev/null @@ -1,42 +0,0 @@ -# RabbitMQ - -## RabbitMQSinkConnector：从 EventMesh 到 RabbitMQ - -1. 启动你的 RabbitMQ 和 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 启动你的 RabbitMQConnectorServer，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据发送到 RabbitMQ 中的 `connectorConfig.queueName`。 -4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 RabbitMQ 中接收到该消息。 - -```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 中的 `connectorConfig.queueName`，并将数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject`。 -4. 向队列发送一个 CloudEvent 消息，然后你将在 EventMesh 中接收到该消息。 \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-redis/README.md b/eventmesh-connectors/eventmesh-connector-redis/README.md deleted file mode 100644 index 10aab6d33e..0000000000 --- a/eventmesh-connectors/eventmesh-connector-redis/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# 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. \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-redis/README_CN.md b/eventmesh-connectors/eventmesh-connector-redis/README_CN.md deleted file mode 100644 index cf56c33b64..0000000000 --- a/eventmesh-connectors/eventmesh-connector-redis/README_CN.md +++ /dev/null @@ -1,33 +0,0 @@ -# Redis - -## RedisSinkConnector：从 EventMesh 到 Redis 的消息队列 - -1. 启动你的 Redis 实例和 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 启动你的 `RedisConnectServer`，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据发送到 Redis 中的 `connectorConfig.topic`。 -4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 Redis 中接收到该消息。 - -```yaml -pubSubConfig: - # 默认端口 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 - # Redis 中的主题 - topic: SinkTopic -``` - -## RedisSourceConnector：从 Redis 的消息队列 到 EventMesh - -1. 启动你的 Redis 实例和 EventMesh Runtime。 -2. 启用 sourceConnector 并检查 `source-config.yml`（与 sink-config.yml 基本相同）。 -3. 启动你的 RedisConnectServer，它将订阅到 Redis 中的 `connectorConfig.topic`，并将数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject` -4. 向 Redis 的主题发送一个 CloudEvent 消息，然后你将在 EventMesh 中接收到该消息。 \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-slack/README.md b/eventmesh-connectors/eventmesh-connector-slack/README.md deleted file mode 100644 index cee677985b..0000000000 --- a/eventmesh-connectors/eventmesh-connector-slack/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# 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 -``` \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-slack/README_CN.md b/eventmesh-connectors/eventmesh-connector-slack/README_CN.md deleted file mode 100644 index ede3d66b03..0000000000 --- a/eventmesh-connectors/eventmesh-connector-slack/README_CN.md +++ /dev/null @@ -1,25 +0,0 @@ -# Slack - -## SlackSinkConnector：从 EventMesh 到 Slack - -1. 启动你的 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息。 - -```yaml -pubSubConfig: - # 默认端口 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 - # 以下配置请参考文档：https://api.slack.com/messaging/sending - appToken: slackAppToken - channelId: slackChannelId -``` \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-wecom/README.md b/eventmesh-connectors/eventmesh-connector-wecom/README.md deleted file mode 100644 index 62e834ef0d..0000000000 --- a/eventmesh-connectors/eventmesh-connector-wecom/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# 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. \ No newline at end of file diff --git a/eventmesh-connectors/eventmesh-connector-wecom/README_CN.md b/eventmesh-connectors/eventmesh-connector-wecom/README_CN.md deleted file mode 100644 index 334a51eaad..0000000000 --- a/eventmesh-connectors/eventmesh-connector-wecom/README_CN.md +++ /dev/null @@ -1,30 +0,0 @@ -# 企业微信 - -## WecomSinkConnector：从 EventMesh 到企业微信 - -1. 启动你的 EventMesh Runtime。 -2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息。 - -```yaml -pubSubConfig: - # 默认端口 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 - # 以下配置请参考文档：https://developer.work.weixin.qq.com/document/path/90236 - robotWebhookKey: weComRobotWebhookKey -``` - -### CloudEvent 属性 - -使用 eventmesh-connector-wecom 下沉事件时，需要在 CloudEvent 中添加对应的 extension filed： - -- 当 key=`wecomtemplatetype`时，value=`text`/`markdown`，表明该事件的文本类型。 \ No newline at end of file