From 5c8f47cde45da21fd4c8472f033a38fd8bfc8f51 Mon Sep 17 00:00:00 2001 From: sh1yu <41428433@qq.com> Date: Mon, 11 Mar 2024 16:32:23 +0800 Subject: [PATCH 1/2] add fileConnector --- .../03-connect/10-file-connector.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md new file mode 100644 index 0000000000..3106703037 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md @@ -0,0 +1,46 @@ +# File +## FileSinkConnector：从 EventMesh 写入文件 File +1. 启动你的 EventMesh Runtime。 +2. 启用 sinkConnector 并检查 `sink-config.yml`。 +3. 启动你的 FileConnectServer，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据写入到 路径位于： `connectorConfig.topic`/年/月/日 ；名为： 【 `connectorConfig.topic` + 当前时间小时位（24小时制 + 时间戳 】的文件 +4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 文件 中持久化该消息。 +```yaml +# 公共配置 +pubSubConfig: + meshAddress: 127.0.0.1:10000 + subject: TopicTest + idc: FT + env: PRD + group: fileSink + appId: 5031 + userName: fileSinkUser + passWord: filePassWord +connectorConfig: + connectorName: fileSink + #主题 一般和pubSubConfig.subject配置成一样的，生成文件的文件名中含有此属性配置值 + topic: TopicTest +``` + +## FileSourceConnector：从 File 文件读取 到 EventMesh +1. 启动你的 EventMesh Runtime。 +2. 启用 sourceConnector 并检查 `source-config.yml`。 +3. 启动你的 FileConnectServer，它将从 `connectorConfig.filePath `中读取的数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject`。 +4. 文件内容的 追加操作 会被识别，然后你将在 EventMesh 中接收到该消息 +```yaml +# 公共配置 +pubSubConfig: + meshAddress: 127.0.0.1:10000 + subject: TopicTest + idc: FT + env: PRD + group: fileSource + appId: 5032 + userName: fileSourceUser + passWord: filePassWord +connectorConfig: + connectorName: fileSource + # 源文件地址 + filePath: userFilePath +``` + +> 特殊说明：如果没能获取源文件或汇入文件，则使用 System.in 和 System.out \ No newline at end of file From bdccb06b890df47c8e93e7221a0a3d23ad93aabe Mon Sep 17 00:00:00 2001 From: sh1yu <41428433@qq.com> Date: Mon, 11 Mar 2024 17:30:41 +0800 Subject: [PATCH 2/2] add a Eng version --- .../03-connect/10-file-connector.md | 51 +++++++++++++++++++ .../03-connect/10-file-connector.md | 7 ++- 2 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 docs/design-document/03-connect/10-file-connector.md diff --git a/docs/design-document/03-connect/10-file-connector.md b/docs/design-document/03-connect/10-file-connector.md new file mode 100644 index 0000000000..0aeedd0f75 --- /dev/null +++ b/docs/design-document/03-connect/10-file-connector.md @@ -0,0 +1,51 @@ +# File + +## FileSinkConnector：Writes File file from EventMesh + +1. Start your EventMesh Runtime. +2. Enable sinkConnector and check `sink-config.yml`. +3. Started FileConnectServer，It will subscribe to the topic defined in `pubSubConfig.subject` in the EventMesh Runtime，And write the data to the path located : `connectorConfig.topic`/Year/Month/Day ; the file named:【 `connectorConfig.topic` + Current time Hour (24 hours) + timestamp 】. +4. Using the Topic specified in `pubSubConfig.subject`, send a message to EventMesh, which you will persist in the file. + +```yaml +# public config +pubSubConfig: + meshAddress: 127.0.0.1:10000 + subject: TopicTest + idc: FT + env: PRD + group: fileSink + appId: 5031 + userName: fileSinkUser + passWord: filePassWord +connectorConfig: + connectorName: fileSink + #topic Generally, the configuration is the same as that of pubSubConfig.subject. The generated file name contains the configuration value of this property + topic: TopicTest +``` + +## FileSourceConnector：Read from File to EventMesh + +1. Start your EventMesh Runtime. +2. Enable sinkConnector and check `source-config.yml`. +3. Started FileConnectServer，It sends the data read from `connectorConfig.filePath` to `pubSubConfig.subject` in the EventMesh Runtime. +4. The append to the file content is recognized, and you receive the message in EventMesh + +```yaml +# public config +pubSubConfig: + meshAddress: 127.0.0.1:10000 + subject: TopicTest + idc: FT + env: PRD + group: fileSource + appId: 5032 + userName: fileSourceUser + passWord: filePassWord +connectorConfig: + connectorName: fileSource + # Source file address + filePath: userFilePath +``` + +> Special note: System.in and System.out are used if the source file or import file cannot be retrieved \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md index 3106703037..ecf03fb674 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/10-file-connector.md @@ -1,9 +1,12 @@ # File + ## FileSinkConnector：从 EventMesh 写入文件 File + 1. 启动你的 EventMesh Runtime。 2. 启用 sinkConnector 并检查 `sink-config.yml`。 -3. 启动你的 FileConnectServer，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据写入到 路径位于： `connectorConfig.topic`/年/月/日 ；名为： 【 `connectorConfig.topic` + 当前时间小时位（24小时制 + 时间戳 】的文件 +3. 启动你的 FileConnectServer，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将数据写入到 路径位于： `connectorConfig.topic`/年/月/日 ；名为： 【 `connectorConfig.topic` + 当前时间小时位（24小时制） + 时间戳 】的文件 4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 文件 中持久化该消息。 + ```yaml # 公共配置 pubSubConfig: @@ -22,10 +25,12 @@ connectorConfig: ``` ## FileSourceConnector：从 File 文件读取 到 EventMesh + 1. 启动你的 EventMesh Runtime。 2. 启用 sourceConnector 并检查 `source-config.yml`。 3. 启动你的 FileConnectServer，它将从 `connectorConfig.filePath `中读取的数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject`。 4. 文件内容的 追加操作 会被识别，然后你将在 EventMesh 中接收到该消息 + ```yaml # 公共配置 pubSubConfig: