This is an automated email from the ASF dual-hosted git repository.
wenweihuang 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 82ea247e98e [INLONG-997][Agent] Add Agent management doc (#998)
82ea247e98e is described below
commit 82ea247e98e91469fa88ce1f19b8281aa4749ade
Author: justinwwhuang <hww_jus...@163.com>
AuthorDate: Fri Sep 27 20:00:21 2024 +0800
[INLONG-997][Agent] Add Agent management doc (#998)
* [INLONG-997][Agent] Add Agent management doc
* Update
i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/agent_management.md
Co-authored-by: AloysZhang <lofterzh...@gmail.com>
* [INLONG-997][Agent] Fix description error
* [INLONG-997][Agent] Add English Agent management doc
---------
Co-authored-by: AloysZhang <lofterzh...@gmail.com>
---
.../cluster_management/_category_.json | 4 +
.../cluster_management/agent_management.md | 87 +++++++++++++++++++++
.../cluster_management/img/agent_batch.png | Bin 0 -> 129823 bytes
.../cluster_management/img/agent_install.png | Bin 0 -> 120121 bytes
.../cluster_management/img/agent_modify_delete.png | Bin 0 -> 61990 bytes
.../img/agent_package_modify_delete.png | Bin 0 -> 56926 bytes
.../cluster_management/img/agent_package_new.png | Bin 0 -> 105917 bytes
.../img/agent_version_modify_delete.png | Bin 0 -> 93654 bytes
.../cluster_management/img/agent_version_new.png | Bin 0 -> 139406 bytes
.../cluster_management/agent_management.md | 87 +++++++++++++++++++++
.../cluster_management/img/agent_batch.png | Bin 0 -> 102904 bytes
.../cluster_management/img/agent_install.png | Bin 0 -> 141028 bytes
.../cluster_management/img/agent_modify_delete.png | Bin 0 -> 70819 bytes
.../img/agent_package_modify_delete.png | Bin 0 -> 51930 bytes
.../cluster_management/img/agent_package_new.png | Bin 0 -> 112091 bytes
.../img/agent_version_modify_delete.png | Bin 0 -> 74430 bytes
.../cluster_management/img/agent_version_new.png | Bin 0 -> 132090 bytes
17 files changed, 178 insertions(+)
diff --git a/docs/administration/cluster_management/_category_.json
b/docs/administration/cluster_management/_category_.json
new file mode 100644
index 00000000000..877a90faf83
--- /dev/null
+++ b/docs/administration/cluster_management/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Cluster management",
+ "position": 1
+}
\ No newline at end of file
diff --git a/docs/administration/cluster_management/agent_management.md
b/docs/administration/cluster_management/agent_management.md
new file mode 100644
index 00000000000..81e442ff2a5
--- /dev/null
+++ b/docs/administration/cluster_management/agent_management.md
@@ -0,0 +1,87 @@
+---
+title: Agent management
+sidebar_position: 1
+---
+
+## Overview
+The platform has implemented interface based management capabilities for
agents, supporting installation package management, version management,
installation operations, uninstallation operations, upgrade operations, restart
operations, and batch operations.
+
+## Installation package management
+Installation package management mainly involves managing the name, address,
and MD5 of installation packages.
+### Add
+As shown in the figure, click "Create Package" in "Operation-Package" to
create a new installation package:
+
+File Name: Agent Installation Package Name
+
+Download Url: The download url for the installation package. We download the
installation package through wget.
+
+MD5: The MD5 value of the installation package file, used to verify whether
the installation package is damaged after downloading.
+
+Storage Path: The storage path after the installation package is downloaded.
+
+### Modify and Delete
+Click on "Details" to modify the Agent; Click 'Delete' to delete the
installation package.
+
+
+### Installer
+The Installer is the daemon process of the Agent, and in fact, we install both
the Installer and Agent processes on the business machine. The installation
package, version management, and agent of the Installer are the same.
+
+## Version Management
+Version management is based on installation package management, mainly
managing the installation, inspection, start, and stop commands required for
this installation package.
+### Add
+As shown in the figure, click "Create Module" in "Operations-Version
Management" to create a new version:
+
+Name: Version name.
+
+Version: Version number, which must follow the X.X.X three part specification
and can only be a number.
+
+Installation package: Select the installation package corresponding to this
version.
+
+Check Command: A command used to detect the existence of a process.
+
+Start command: Used to start the process.
+
+Stop command: Used to stop the process.
+
+Uninstall command: Used to uninstall the agent.
+
+### Modify and Delete
+Click on 'Details' to modify the version; Click 'Delete' to delete the version.
+
+
+
+## Agent Installation
+After finding the Agent cluster in the cluster management as shown in the
figure, select "Create":
+
+IP: The IP of the machine where the agent is to be installed.
+
+Protocol Type: Identify the protocol type used by the Agent and Manager for
interaction. If they are on the same local area network, we choose HTTP; If
cross public network transmission is required, choose HTTPS.
+
+Version: Select the version of the Agent.
+
+Installation: If you want the platform to install automatically, please choose
SSH installation, and usually install through SSH password.
+
+SSH Username: SSH login username
+
+SSH Password: SSH login password
+
+SSH Port: SSH port number
+
+After completing the form, you can click the "Test Connection" button to test
whether the SSH login was successful.
+After clicking the 'Save' button, automatic installation will begin.
+## Modify and Delete
+Click 'Edit' to modify the Agent node; Click 'Delete' to delete the Agent node.
+
+
+## Batch Update
+As shown in the figure, we can select multiple Agent nodes and click the
"Batch Update" button to perform batch operations.
+
+Batch Num: We can perform batch operations, which are divided into batches.
+
+Interval: The time interval between each batch.
+
+Operation type: The operation to be performed on this batch of nodes,
+
+Version: Agent version.
+
+Installer: Installer version.
\ No newline at end of file
diff --git a/docs/administration/cluster_management/img/agent_batch.png
b/docs/administration/cluster_management/img/agent_batch.png
new file mode 100644
index 00000000000..27721d5794a
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_batch.png differ
diff --git a/docs/administration/cluster_management/img/agent_install.png
b/docs/administration/cluster_management/img/agent_install.png
new file mode 100644
index 00000000000..19a5361035d
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_install.png differ
diff --git a/docs/administration/cluster_management/img/agent_modify_delete.png
b/docs/administration/cluster_management/img/agent_modify_delete.png
new file mode 100644
index 00000000000..e66db21ce4c
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_modify_delete.png differ
diff --git
a/docs/administration/cluster_management/img/agent_package_modify_delete.png
b/docs/administration/cluster_management/img/agent_package_modify_delete.png
new file mode 100644
index 00000000000..7dc2c7f9f42
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_package_modify_delete.png
differ
diff --git a/docs/administration/cluster_management/img/agent_package_new.png
b/docs/administration/cluster_management/img/agent_package_new.png
new file mode 100644
index 00000000000..f35eec547d0
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_package_new.png differ
diff --git
a/docs/administration/cluster_management/img/agent_version_modify_delete.png
b/docs/administration/cluster_management/img/agent_version_modify_delete.png
new file mode 100644
index 00000000000..2813f738050
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_version_modify_delete.png
differ
diff --git a/docs/administration/cluster_management/img/agent_version_new.png
b/docs/administration/cluster_management/img/agent_version_new.png
new file mode 100644
index 00000000000..98ae6b87c87
Binary files /dev/null and
b/docs/administration/cluster_management/img/agent_version_new.png differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/agent_management.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/agent_management.md
new file mode 100644
index 00000000000..6028b5c37b9
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/agent_management.md
@@ -0,0 +1,87 @@
+---
+title: Agent 管理
+sidebar_position: 1
+---
+
+## 概述
+平台实现了 Agent 的界面化管理能力，支持在界面进行 Agent
的安装包管理、版本管理、安装操作、卸载操作、升级操作、重启操作等，并且支持批量操作的能力。
+
+## 安装包管理
+安装包管理主要是对安装包的名称、地址、MD5 的管理。
+### 新增
+如图所示在 "系统运维-安装包" 点击 "新建 Package" 进行安装包新建：
+
+文件名称：Agent 安装包名称
+
+下载地址：安装包的下载地址，我们是通过 wget 来下载安装包。
+
+MD5：安装包文件的 MD5 值，用于下载完成后校验安装包是否有损坏。
+
+存储路径：安装包下载完成后的存放路径。
+
+### 修改、删除
+点击 "详情" 即可进行 Agent 的修改；点击 "删除" 即可进行安装包删除。
+
+
+### Installer
+Installer 是 Agent 的守护进程，实际上我们在业务机器上同时装了 Installer 和 Agent 两个进程。Installer
的安装包、版本管理和 Agent 一样。
+
+## 版本管理
+版本管理是基于安装包管理之上的，主要是管理这个安装包所需的安装、检查、启动、停止命令。
+### 新增
+如图所示在 "系统运维-版本管理" 点击 "新建 module" 进行版本新建：
+
+名称：版本名称。
+
+版本：版本号，需要遵循 X.X.X 三段式规范，并且只能是数字。
+
+安装包：选择该版本对应的安装包。
+
+检查命令：用于检测进程是否存在的命令。
+
+启动命令：用于启动进程。
+
+停止命令：用于停止进程。
+
+卸载命令：用于卸载 Agent。
+
+### 修改、删除
+点击 "详情" 即可进行版本修改；点击 "删除" 即可进行版本删除。
+
+
+
+## Agent 安装
+如图所示在集群管理里找到 Agent 集群后，选择新建节点：
+
+IP：要安装 Agent 的机器的 IP。
+
+协议类型：标识 Agent 与 Manager 交互所用协议类型，如果是同一个局域网的我们选择 HTTP；如果是需要跨公网传输的就选择 HTTPS。
+
+版本：选择 Agent 的版本。
+
+安装方式：如果要平台自动安装，请选择 SSH 安装，并且一般是通过 SSH 密码安装。
+
+SSH 用户名：SSH 登录用户名
+
+SSH 密码：SSH 登录密码
+
+SSH 端口：SSH 端口号
+
+填写完成后可以点击 "测试连接" 按钮测试 SSH 登录是否成功。
+点击 "保存" 按钮后即可进行自动安装。
+## 修改、删除
+点击 "编辑" 即可进行 Agent 节点修改；点击 "删除" 即可进行 Agent 节点删除。
+
+
+## 批量操作
+如图所示，我们可以选择多个 Agent 节点，然后点击 "批量操作" 按钮进行批量操作。
+
+分批：我们可以进行分批操作，这个是分的批次。
+
+间隔：每个批次之间的时间间隔。
+
+操作类型：对这批节点要进行的操作，
+
+版本：Agent 版本。
+
+Installer：Installer 版本。
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_batch.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_batch.png
new file mode 100644
index 00000000000..ea5d63cdd51
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_batch.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_install.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_install.png
new file mode 100644
index 00000000000..9da5b9a0b72
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_install.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_modify_delete.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_modify_delete.png
new file mode 100644
index 00000000000..3fdc048db93
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_modify_delete.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_modify_delete.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_modify_delete.png
new file mode 100644
index 00000000000..50946d9fe94
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_modify_delete.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_new.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_new.png
new file mode 100644
index 00000000000..9e1ef70d9d3
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_package_new.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_modify_delete.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_modify_delete.png
new file mode 100644
index 00000000000..9395095f858
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_modify_delete.png
differ
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_new.png
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_new.png
new file mode 100644
index 00000000000..3abfeb9d8b2
Binary files /dev/null and
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/administration/cluster_management/img/agent_version_new.png
differ
