Merge pull request #50 from QQDQ/main

ECP V2.0.0 中文文档更新
emqx · Nov 9, 2023 · 8597789 · 8597789
2 parents 2814b5d + bfbf869
commit 8597789
Show file tree

Hide file tree

Showing 105 changed files with 852 additions and 780 deletions.
diff --git a/ecp/directory.json b/ecp/directory.json
@@ -12,71 +12,55 @@
             "title": "安装部署",
             "path": "install/introduction",
             "children": [
-                {
-                    "title": "基于 Kubernetes 部署 ECP",
-                    "path": "install/install_ecp_on_kubernetes"
-                },
                 {
                     "title": "基于 Docker 部署 ECP",
                     "path": "install/install_ecp_on_linux"
                 },
                 {
-                    "title": "部署边缘代理",
-                    "path": "install/install_edge_agent"
-                },
+                    "title": "基于 Kubernetes 部署 ECP",
+                    "path": "install/install_ecp_on_kubernetes"
+                },           
                 {
                     "title": "配置许可证",
                     "path": "install/license_setting"
                 }
             ]
         },
         {
-            "title": "访问控制",
-            "path": "acl/introduction",
-            "children": [
-                {
-                    "title": "认证",
-                    "path": "acl/ecp_login"
-                },
-                {
-                    "title": "授权",
-                    "path": "acl/authorize"
-                },
-                {
-                    "title": "用户管理",
-                    "path": "system_admin/user_management"
-                }
-            ]
-        },
-        {
-            "title": "组织与项目",
-            "path": "system_admin/introduction",
+            "title": "基础模块功能",
+            "path": "system_admin/basical_module",
             "children": [
                 {
-                    "title": "组织管理",
-                    "path": "system_admin/org_management"
-                },
-                {
-                    "title": "项目管理",
-                    "path": "system_admin/project_management"
-                }
-            ]
-        },
-        {
-            "title": "云端集群管理",
-            "path": "cluster/introduction",
-            "children": [
-                {
-                    "title": "添加集群和启停服务",
-                    "path": "cluster/add_manage"
-                },
-                {
-                    "title": "查看 EMQX 集群详情",
-                    "path": "cluster/cluster_details"
+                    "title": "访问控制",
+                    "path": "acl/introduction",
+                    "children": [
+                        {
+                            "title": "认证",
+                            "path": "acl/ecp_login"
+                        },
+                        {
+                            "title": "授权",
+                            "path": "acl/authorize"
+                        },
+                        {
+                            "title": "用户管理",
+                            "path": "system_admin/user_management"
+                        }
+                    ]
                 },
                 {
-                    "title": "EMQX 集群管理运维",
-                    "path": "cluster/ops"
+                    "title": "组织与项目",
+                    "path": "system_admin/introduction",
+                    "children": [
+                        {
+                            "title": "组织管理",
+                            "path": "system_admin/org_management"
+                        },
+                        {
+                            "title": "项目管理",
+                            "path": "system_admin/project_management"
+                        }
+                    ]
                 }
             ]
         },
@@ -85,12 +69,8 @@
             "path": "edge_service/introduction",
             "children": [
                 {
-                    "title": "批量安装边缘服务",
-                    "path": "edge_service/batch_intall"
-                },
-                {
-                    "title": "ECP 边缘代理",
-                    "path": "edge_service/edge_agent_management"
+                    "title": "Docker方式批量安装边缘服务",
+                    "path": "edge_service/batch_install"
                 },
                 {
                     "title": "ECP 边缘节点",
@@ -117,7 +97,7 @@
                     "path": "edge_service/batch_upgrade"
                 },
                 {
-                    "title": "边缘配置批量下发",
+                    "title": "边缘服务配置批量下发",
                     "path": "edge_service/batch_distribution"
                 },
                 {
@@ -127,7 +107,25 @@
             ]
         },
         {
-            "title": "日志与可观测性",
+            "title": "云端集群管理",
+            "path": "cluster/introduction",
+            "children": [
+                {
+                    "title": "添加集群和启停服务",
+                    "path": "cluster/add_manage"
+                },
+                {
+                    "title": "查看 EMQX 集群详情",
+                    "path": "cluster/cluster_details"
+                },
+                {
+                    "title": "EMQX 集群管理运维",
+                    "path": "cluster/ops"
+                }
+            ]
+        },
+        {
+            "title": "统一运维服务",
             "path": "monitor/introduction",
             "children": [
                 {
@@ -149,13 +147,13 @@
                 {
                     "title": "告警规则列表",
                     "path": "monitor/rules"
+                },
+                {
+                    "title": "操作审计",
+                    "path": "system_admin/operation_audit"
                 }
             ]
         },
-        {
-            "title": "操作审计",
-            "path": "system_admin/operation_audit"
-        },
         {
             "title": "系统设置",
             "path": "system_admin/system_managment",
@@ -200,17 +198,13 @@
             "title": "Installation",
             "path": "install/introduction",
             "children": [
-                {
-                    "title": "Deploy with Kubernetes",
-                    "path": "install/install_ecp_on_kubernetes"
-                },
                 {
                     "title": "Deploy with Docker",
                     "path": "install/install_ecp_on_linux"
                 },
                 {
-                    "title": "Install ECP Edge Agent",
-                    "path": "install/install_edge_agent"
+                    "title": "Deploy with Kubernetes",
+                    "path": "install/install_ecp_on_kubernetes"
                 },
                 {
                     "title": "Configure License",
@@ -250,24 +244,6 @@
                 }
             ]
         },
-        {
-            "title": "Manage EMQX Clusters",
-            "path": "cluster/introduction",
-            "children": [
-                {
-                    "title": "Add EMQX Clusters",
-                    "path": "cluster/add_manage"
-                },
-                {
-                    "title": "View EMQX Cluster Details",
-                    "path": "cluster/cluster_details"
-                },
-                {
-                    "title": "Manage EMQX Clusters",
-                    "path": "cluster/ops"
-                }
-            ]
-        },
         {
             "title": "Manage Edge Services",
             "path": "edge_service/introduction",
@@ -315,7 +291,25 @@
             ]
         },
         {
-            "title": "Logs and Observability",
+            "title": "Manage EMQX Clusters",
+            "path": "cluster/introduction",
+            "children": [
+                {
+                    "title": "Add EMQX Clusters",
+                    "path": "cluster/add_manage"
+                },
+                {
+                    "title": "View EMQX Cluster Details",
+                    "path": "cluster/cluster_details"
+                },
+                {
+                    "title": "Manage EMQX Clusters",
+                    "path": "cluster/ops"
+                }
+            ]
+        },
+        {
+            "title": "Operation Management",
             "path": "monitor/introduction",
             "children": [
                 {
@@ -337,13 +331,13 @@
                 {
                     "title": "Alarm List",
                     "path": "monitor/rules"
+                },
+                {
+                    "title": "Audit",
+                    "path": "system_admin/operation_audit"
                 }
             ]
         },
-        {
-            "title": "Audit",
-            "path": "system_admin/operation_audit"
-        },
         {
             "title": "System Settings",
             "path": "system_admin/system_managment",

diff --git a/ecp/en_US/_assets/function_architecture.png b/ecp/en_US/_assets/function_architecture.png
diff --git a/ecp/en_US/_assets/title.png b/ecp/en_US/_assets/title.png
diff --git a/ecp/en_US/edge_service/_assets/edge-batch-upgrade-confirm.png b/ecp/en_US/edge_service/_assets/edge-batch-upgrade-confirm.png
diff --git a/ecp/en_US/edge_service/_assets/edge-batch-upgrade-edges.png b/ecp/en_US/edge_service/_assets/edge-batch-upgrade-edges.png
diff --git a/ecp/en_US/edge_service/_assets/edge-batch-upgrade-panel.png b/ecp/en_US/edge_service/_assets/edge-batch-upgrade-panel.png
diff --git a/ecp/en_US/edge_service/_assets/edge-batch-upgrade-pop.png b/ecp/en_US/edge_service/_assets/edge-batch-upgrade-pop.png
diff --git a/ecp/en_US/edge_service/_assets/edge-batch-upgrade-results.png b/ecp/en_US/edge_service/_assets/edge-batch-upgrade-results.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-distribution-choose.png b/ecp/en_US/edge_service/_assets/edge-list-distribution-choose.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-distribution-edit.png b/ecp/en_US/edge_service/_assets/edge-list-distribution-edit.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-distribution-function.png b/ecp/en_US/edge_service/_assets/edge-list-distribution-function.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-distribution-result.png b/ecp/en_US/edge_service/_assets/edge-list-distribution-result.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-distribution-template.png b/ecp/en_US/edge_service/_assets/edge-list-distribution-template.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-groupfilter.png b/ecp/en_US/edge_service/_assets/edge-list-groupfilter.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-ops.png b/ecp/en_US/edge_service/_assets/edge-list-ops.png
diff --git a/ecp/en_US/edge_service/_assets/edge-list-pro_monitor.png b/ecp/en_US/edge_service/_assets/edge-list-pro_monitor.png
diff --git a/ecp/en_US/edge_service/_assets/edge-service-add.png b/ecp/en_US/edge_service/_assets/edge-service-add.png
diff --git a/ecp/en_US/edge_service/_assets/edge-tag-allocation.png b/ecp/en_US/edge_service/_assets/edge-tag-allocation.png
diff --git a/ecp/en_US/edge_service/batch_distribution.md b/ecp/en_US/edge_service/batch_distribution.md
@@ -2,7 +2,7 @@
 
 In the edge computing environment, various software runs on edge devices, each requiring configurations tailored to specific applications and business requirements. 
 
-With ECP, you can simultaneously transmit identical or similar configurations to multiple edge device software (such as Neuron and eKuiper). This approach helps administrators apply rapid, consistent, and reliable configuration strategies, minimizing configuration errors and redundant tasks, thereby boosting the stability and reliability of the edge computing environment.
+With ECP, you can simultaneously transmit identical or similar configurations to multiple edge device software. This approach helps administrators apply rapid, consistent, and reliable configuration strategies, minimizing configuration errors and redundant tasks, thereby boosting the stability and reliability of the edge computing environment.
 
 :::tip
 ECP will set some restrictions for system protection purposes. For specific usage restrictions, please refer to [System Usage Restrictions](../others/known_limitations.md) and [Version Compatibility](../others/version_limitations).
@@ -22,6 +22,11 @@ To create a template:
 
 
 
+## Choose Function
+
+Select either  `Data Acquisition` or  `Data Processing` to deliver the configuration to other NeuronEX.
+
+![function](./_assets/edge-list-distribution-function.png)
 
 ## Edit Template
 
@@ -42,7 +47,7 @@ Original:
 Parameterized:
 
 ```
-"mqtt": "{\"stream1\":{\"insecureSkipVerify\":false,\"protocolVersion\":\"3.1.1\",\"qos\":1,\"server\":\" ${tcp_addr} "}}"
+"mqtt": "{\"stream1\":{\"insecureSkipVerify\":false,\"protocolVersion\":\"3.1.1\",\"qos\":1,\"server\":\" ${tcp_addr} \"}}"
 ```
 
 After the edit, click **Next** to select the target edge services.
@@ -53,10 +58,6 @@ You can filter by name, EndPoint, Version, or [tags](./batch_tag.md), then click
 
 <img src="./_assets/edge-list-distribution-edit.png" alt="template" style="zoom:50%;" />
 
-:::tip
-Selected instances should have the same product type as specified in the template.
-:::
-
 ## Edit Parameters
 
 This feature allows the assignment of values to parameters for multiple edge services at once, enhancing configuration efficiency.

diff --git a/ecp/en_US/edge_service/batch_import.md b/ecp/en_US/edge_service/batch_import.md
@@ -1,10 +1,10 @@
 # Add Existing Edge Services
 
-ECP provides the capability to manage existing edge services. However, these services must first be added to ECP. You can add them either [one by one](#add-an-existing-edge-service) or, if adding Neuron or eKuiper edge services, you can do so [in bulk](#add-existing-edge-services-in-bulk).
+ECP provides the capability to manage existing edge services. However, these services must first be added to ECP. You can add [an externally created edge service](#add-an-existing-edge-service), or [import them from csv in bulk](#add-existing-edge-services-in-bulk).
 
 ## Add an Existing Edge Service
 
-ECP supports the addition of a Neuron or eKuiper in both [direct connection](#direct-connection-mode) and [proxy modes](#proxy-mode).
+ECP supports to add a NeuronEX instance in [direct connection mode](#direct-connection-mode).
 
 ### Direct Connection Mode
 
@@ -13,11 +13,11 @@ Direct connection mode generally refers to the scenario where the cluster and al
 1. Log in as system admin, organization admin, or project admin. 
 2. Click the **Add Edge Service** button to enter the **Add Edge Service** page.
 3. Choose **Add existing service** for **Add Type**.
-4. For **Category**, you can choose **eKuiper**, **Neuron**, **NanoMQ**, or **Customize**.
+4. For **Category**, choose **NeuronEX**.
 5. Choose **Direct Connection** for the **Connection Type**;
 6. Give a name to the edge service; it should be 1 - 200 characters, and also support "-" and blank spaces. 
 7. Enter the access address of the edge service. HTTP and HTTPS protocols are supported;
-8. Add tags to facilitate future management. For details, see [Tags](./batch_tag.md).
+8. Optionally add tags to facilitate future management. For details, see [Tags](./batch_tag.md).
 9. Click the **Confirm** button to finish the creation. The newly-added edge service is now displayed in the **Edge Service** section. 
 
 <img src="./_assets/edge-service-add.png" style="zoom:60%;" align="middle"> 
@@ -53,15 +53,15 @@ After the import, the imported edge services will automatically be displayed in
 
 The following table provides an overview of the column names of the .csv file and their corresponding explanations:
 
-| Column    | Explanation                              |
-| --------- | ---------------------------------------- |
-| category  | Edge product type                        |
-| name      | Edge service name                        |
-| nodeType  | Direct/Proxy                             |
-| endpoint  | Edge service address                     |
-| scheme    | http/https/MQTT                          |
-| agentID   | Edge agent ID, optional                  |
-| tagName   | Tag name, optional                       |
-| serviceID | Edge service ID, optional                |
-| username  | NanoMQ authentication username, optional |
-| password  | NanoMQ authentication password, optional |
+| Column    | Explanation                       |
+| --------- | --------------------------------- |
+| category  | Edge product type                 |
+| name      | Edge service name                 |
+| nodeType  | Direct/Proxy                      |
+| endpoint  | Edge service address              |
+| scheme    | http/https/MQTT                   |
+| agentID   | Edge agent ID, optional           |
+| tagName   | Tag name, optional                |
+| serviceID | Edge service ID, optional         |
+| username  | Authentication username, optional |
+| password  | Authentication password, optional |