This is an automated email from the ASF dual-hosted git repository. dockerzhang pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push: new 184dec287a8 [INLONG-984][Doc] Add data node management document (#987) 184dec287a8 is described below commit 184dec287a843dfa7298ffe0a84dc727910ff1ea Author: fuweng11 <76141879+fuwen...@users.noreply.github.com> AuthorDate: Wed Sep 25 17:49:40 2024 +0800 [INLONG-984][Doc] Add data node management document (#987) --- docs/administration/img/create_node.png | Bin 0 -> 392047 bytes docs/administration/img/delete_node.png | Bin 0 -> 294566 bytes docs/administration/img/test_connection.png | Bin 0 -> 358367 bytes docs/administration/img/update_node.png | Bin 0 -> 290739 bytes docs/administration/img/use_node_1.png | Bin 0 -> 361320 bytes docs/administration/img/use_node_2.png | Bin 0 -> 487762 bytes docs/administration/node_management.md | 51 +++++++++++++++++++++ .../current/administration/img/create_node.png | Bin 0 -> 368792 bytes .../current/administration/img/delete_node.png | Bin 0 -> 294356 bytes .../current/administration/img/test_connection.png | Bin 0 -> 358822 bytes .../current/administration/img/update_node.png | Bin 0 -> 297353 bytes .../current/administration/img/use_node_1.png | Bin 0 -> 358238 bytes .../current/administration/img/use_node_2.png | Bin 0 -> 498801 bytes .../current/administration/node_management.md | 50 ++++++++++++++++++++ 14 files changed, 101 insertions(+) diff --git a/docs/administration/img/create_node.png b/docs/administration/img/create_node.png new file mode 100644 index 00000000000..4998c99aaf3 Binary files /dev/null and b/docs/administration/img/create_node.png differ diff --git a/docs/administration/img/delete_node.png b/docs/administration/img/delete_node.png new file mode 100644 index 00000000000..c995cf7415d Binary files /dev/null and b/docs/administration/img/delete_node.png differ diff --git a/docs/administration/img/test_connection.png b/docs/administration/img/test_connection.png new file mode 100644 index 00000000000..20bfa3ba9fe Binary files /dev/null and b/docs/administration/img/test_connection.png differ diff --git a/docs/administration/img/update_node.png b/docs/administration/img/update_node.png new file mode 100644 index 00000000000..8f57e25c788 Binary files /dev/null and b/docs/administration/img/update_node.png differ diff --git a/docs/administration/img/use_node_1.png b/docs/administration/img/use_node_1.png new file mode 100644 index 00000000000..400dd55ba0a Binary files /dev/null and b/docs/administration/img/use_node_1.png differ diff --git a/docs/administration/img/use_node_2.png b/docs/administration/img/use_node_2.png new file mode 100644 index 00000000000..92dcabecabe Binary files /dev/null and b/docs/administration/img/use_node_2.png differ diff --git a/docs/administration/node_management.md b/docs/administration/node_management.md new file mode 100644 index 00000000000..a2965f421cb --- /dev/null +++ b/docs/administration/node_management.md @@ -0,0 +1,51 @@ +--- +title: Node Management +sidebar_position: 4 +--- + +## Overview + +In Long, a data node represents a set of server address configurations, which can serve as both the source end for data collection and the storage end for data subscription. For example, when using a MySQL node, the registered information includes the MySQL address, username, and password. During data collection or subscription, this node information can be used to indicate that data collection or storage operations are performed from this MySQL server. + +Node management provides users with the ability to reuse data node information, allowing users to create, modify, and delete data nodes, and reuse configured data node information during data access: + +### Create data node + +Users can create data node to generate a commonly used node information: + + + +- name: A user-defined name to identify this node information. +- type:The type of the node. +- owners:The person responsible for this node, only the person in charge can modify the configuration information of this node. +- description:Node description information. + +The above are the common configurations of the node. In addition, according to different node types, there will be different configuration information. For example, ClickHouse nodes need to fill in the username, password, and ClickHouse address information. + +### Delete data node + +Users can delete data node. After delete, this node will stop being used: + + + +### Update data node + +Users can update node information. Click [Edit], enter the new node information, and after confirmation, this node configuration will take effect: + + + +### Test connection + +Users can use the test connection to verify whether the node status is normal: + + + +### Use data node + +After configuring the node, users can use the configured node information in data subscription: + +- select 【Ingestion】,and click 【Detail】 +  +- When selecting a data target, choose 【Create】, select a configured data node, complete other configurations, and then click Save. +  + At this point, the node usage process is complete. diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_node.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_node.png new file mode 100644 index 00000000000..d888fbe3d36 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/create_node.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/delete_node.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/delete_node.png new file mode 100644 index 00000000000..ac223046bc0 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/delete_node.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/test_connection.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/test_connection.png new file mode 100644 index 00000000000..b9bb9f538d7 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/test_connection.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/update_node.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/update_node.png new file mode 100644 index 00000000000..7432974d874 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/update_node.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_1.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_1.png new file mode 100644 index 00000000000..2d96101293c Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_1.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_2.png b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_2.png new file mode 100644 index 00000000000..24e2cf631b7 Binary files /dev/null and b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/img/use_node_2.png differ diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/node_management.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/node_management.md new file mode 100644 index 00000000000..b417241db74 --- /dev/null +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/node_management.md @@ -0,0 +1,50 @@ +--- +title: 节点管理 +sidebar_position: 4 +--- +## 总览 + +数据节点在 InLong 中表示的是一组服务器地址配置,可以作为数据采集的源端,也可以作为数据订阅的入库端,比如说当使用 MySQL 节点时,登记的就是 MySQL 的地址、用户名、密码,在使用数据采集或者订阅时,可以使用该节点信息,表示从此 MySQL 进行数据采集或者数据入库操作。 + +节点管理主要提供数据节点信息复用的能力,用户可以在新建、修改、删除数据节点,并且在进行数据接入时,复用配置好的数据节点信息: + +### 新建数据节点 + +用户可以通过新建数据节点来生成一个常用的节点信息: + + + +- 节点名:用户自定义名,用来标识此节点信息 +- 类型:节点类型 +- 责任人:该节点负责人,只有责任人能够修改该节点的配置信息 +- 描述:节点描述信息 + +以上为节点的公用配置,另外,根据不同的节点类型,还会有不同的配置信息,如 ClickHouse 节点需要填写用户名、密码、ClickHouse 地址信息。 + +### 删除数据节点 + +用户可以对已创建节点进行删除,删除后此节点将停止使用: + + + +### 修改数据节点 + +用户可以修改节点信息,点击【编辑】,输入新的节点信息,确认后此节点配置将生效: + + + +### 测试连接 + +用户通过测试连接校验节点状态是否正常: + + + +### 使用节点 + +用户配置好节点后,可以在数据订阅中使用已经配置好的节点信息: + +- 选择【数据接入】,点击【详情】 +  +- 选择数据目标【新建】,选择已经配置好的数据节点,并完善其他配置后点击保存。 +  + 至此完成了节点的使用 \ No newline at end of file