Merge pull request #89 from QQDQ/main

update ecp 2.2 document

ecp/directory.json

@@ -69,23 +69,31 @@
             "path": "edge_service/introduction",
             "children": [
                 {
-                    "title": "Docker方式批量安装边缘服务",
+                    "title": "纳管边缘服务",
+                    "path": "edge_service/batch_import"
+                },
+                {
+                    "title": "代理纳管边缘服务",
+                    "path": "edge_service/edge_agent_management"
+                },
+                {
+                    "title": "Docker方式托管边缘服务",
                     "path": "edge_service/batch_install"
                 },
                 {
-                    "title": "ECP 边缘节点",
-                    "path": "edge_service/docker_node"
+                    "title": "升级边缘服务",
+                    "path": "edge_service/batch_upgrade"
                 },
                 {
-                    "title": "导入现有边缘服务",
-                    "path": "edge_service/batch_import"
+                    "title": "边缘服务管理运维",
+                    "path": "edge_service/edge_ops"
                 },
                 {
-                    "title": "代理方式管理边缘服务",
-                    "path": "edge_service/edge_agent_management"
+                    "title": "边缘服务配置管理和下发",
+                    "path": "edge_service/edge_resource_management"
                 },
                 {
-                    "title": "项目级监控统计",
+                    "title": "边缘服务监控统计",
                     "path": "edge_service/edge_project_statistics"
                 },
                 {
@@ -96,18 +104,6 @@
                     "title": "标签分组",
                     "path": "edge_service/batch_tag"
                 },
-                {
-                    "title": "升级边缘服务",
-                    "path": "edge_service/batch_upgrade"
-                },
-                {
-                    "title": "边缘配置管理和下发",
-                    "path": "edge_service/edge_resource_management"
-                },
-                {
-                    "title": "边缘服务管理运维",
-                    "path": "edge_service/edge_ops"
-                },
                 {
                     "title": "云边通道",
                     "path": "edge_service/edge_cloud_tunnel"
@@ -261,40 +257,40 @@
             "path": "edge_service/introduction",
             "children": [
                 {
-                    "title": "Edge Services Batch Installation Docker Mode",
-                    "path": "edge_service/batch_intall"
+                    "title": "Manage Edge Services",
+                    "path": "edge_service/batch_import"
                 },
                 {
-                    "title": "ECP Edge Node",
-                    "path": "edge_service/docker_node"
+                    "title": "Manage Edge Services by Agent",
+                    "path": "edge_service/edge_agent_management"
                 },
                 {
-                    "title": "Add Existing Edge Services",
-                    "path": "edge_service/batch_import"
+                    "title": "Host Edge Services By Docker",
+                    "path": "edge_service/batch_intall"
                 },
                 {
-                    "title": "Project Level Overview",
-                    "path": "edge_service/edge_project_statistics"
+                    "title": "Upgrade Edge Services",
+                    "path": "edge_service/batch_upgrade"
                 },
                 {
-                    "title": "Authenticate Edge Services",
-                    "path": "edge_service/e2c"
+                    "title": "Edge Service Operations",
+                    "path": "edge_service/edge_ops"
                 },
                 {
-                    "title": "Tags and Grouping",
-                    "path": "edge_service/batch_tag"
+                    "title": "Edge Service Config Management and Delivery",
+                    "path": "edge_service/edge_resource_management"
                 },
                 {
-                    "title": "Upgrade Edge Services",
-                    "path": "edge_service/batch_upgrade"
+                    "title": "Edge Service Monitoring",
+                    "path": "edge_service/edge_project_statistics"
                 },
                 {
-                    "title": "Edge Config Management and Delivery",
-                    "path": "edge_service/edge_resource_management"
+                    "title": "Authenticate Edge Services",
+                    "path": "edge_service/e2c"
                 },
                 {
-                    "title": "Edge Service Management & Operations",
-                    "path": "edge_service/edge_ops"
+                    "title": "Tags",
+                    "path": "edge_service/batch_tag"
                 },
                 {
                     "title": "Edge Cloud Tunnel",

ecp/en_US/cluster/add_manage.md

@@ -2,7 +2,7 @@
 
 ECP supports adding clusters by creating (recommended) or adding existing EMQX clusters. It is recommended to add clusters by creating with ECP, which offers more extensive functionality and allows for license and connection quota sharing. 
 
-There are functional differences between creating and managing clusters on the ECP platform, as shown in the table below.
+There are functional differences between creating (**Hosted Clusters**) and managing clusters (**Managed Clusters**) on the ECP platform, as shown in the table below.
 
 |Function|Hosted Clusters|Managed Clusters|
 |:--------:|:----:|:----:|
@@ -35,25 +35,29 @@ The newly-created clusters will be listed in the **Cluster List** panel with the
 
 ## Add an Existing Cluster
 
-ECP also provides the capability to manage existing EMQX clusters. To add an existing cluster, you can operate as follows: 
+ECP also provides the capability to manage existing EMQX clusters. ECP supports the management of EMQX v4 (version 4.4.6 and above) and EMQX v5 (version 5.6.0 and above).
+
+### EMQX V4 Managed Cluster
 
 1. Log in to the ECP platform as a system admin, organization admin, or project admin. In **Workspace - Cluster** page, click **Add Cluster**.
 
-2. Click to select **Existing Cluster** under **New Cluster**.
+2. Click to select **Existing Cluster** under **Cluster Type**.
 
-3. Provide a name for the cluster in the **Cluster Name** field. The name should be between 1-200 characters long and can include "\_" and blank spaces.
+3. Select **v4** under **Cluster Version**.
 
-4. Click **Confirm** to finish the adding process. The newly-created clusters will be listed in the **Cluster List** panel with the status **Created**.   
+4. Provide a name for the cluster in the **Cluster Name** field. The name should be between 1-200 characters long and can include "\_" and blank spaces.
 
-5. Click **Register Node** and a cluster registration guide page will pop up. 
+5. Click **Confirm** to finish the adding process. The newly-created clusters will be listed in the **Cluster List** panel with the status **Created**.   
+
+6. Click **Register Node** and a cluster registration guide page will pop up. 
 
    <img src="./_assets/cluster-existing-init.png" alt="cluster-running" style="zoom:50%;" />
 
-6. Select the CPU architecture in the **CPU Architecture** field, amd64, arm, and arm64 are supported. Follow the steps on this page to finish adding the existing cluster.
+7. Select the CPU architecture in the **CPU Architecture** field, amd64, arm, and arm64 are supported. Follow the steps on this page to finish adding the existing cluster.
 
    <img src="./_assets/cluster-existing-reg.png" style="zoom: 50%;" align="middle"> 
 
-7. Log in to the virtual machine or container environment hosting the EMQX cluster, such as the container named `emqx-69f4249c-emax-ee-0` in the namespace `emqx-69f4249c`.
+8. Log in to the virtual machine or container environment hosting the EMQX cluster, such as the container named `emqx-69f4249c-emax-ee-0` in the namespace `emqx-69f4249c`.
 
    ```bash
    # Check the Pod name
@@ -84,6 +88,26 @@ ECP also provides the capability to manage existing EMQX clusters. To add an exi
 
 9. Upon returning to the **ECP Workbench - Cluster** page, you will find that the newly added existing cluster is now in the **Running** status.![](./_assets/cluster-existing.png) 
 
+### EMQX V5 Managed Cluster
+
+1. Log in to the ECP platform as a system admin, organization admin, or project admin. In **Workspace - Cluster** page, click **Add Cluster**.
+
+2. Click to select **Existing Cluster** under **Cluster Type**.
+
+3. Select **v5** under **Cluster Version**.
+
+4. Provide a name for the cluster in the **Cluster Name** field. The name should be between 1-200 characters long and can include "\_" and blank spaces.
+
+5. Fill in the **Cluster Address** (i.e. EMQX dashboard access address) and dashboard login username and password.
+
+6. Click **Confirm** to finish the adding process. The newly-created clusters will be listed in the **Cluster List** panel with the status **Created**.   
+
+![cluster-v5](./_assets/cluster-v5.png)  
+
+7. Click the **Details** button in the operation column to enter the cluster details, and then click the **Enter Dashboard** button. You will directly view the EMQX v5 dashboard in a new window.
+
+![cluster-v5-dashboard](./_assets/cluster-v5-dashboard.png)  
+
 
 ## Cluster Status
 

ecp/en_US/edge_service/batch_import.md

@@ -1,10 +1,12 @@
-# Add Existing Edge Services
+# Managed Edge Services
 
-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).
+ECP supports [Add an existing edge service](#add-an-existing-edge-service), or [Batch Import Existing Edge Services](#batch-import-existing-edge-services) via CSV files.
 
-## Add an Existing Edge Service
+## Add an existing service
 
-ECP supports to add a NeuronEX instance in [direct connection mode](#direct-connection-mode).
+ECP manages edge services and supports `Managed - Direct Connection` mode and `Managed - Agent` mode. To add an edge service under [Direct Connection Mode](#direct-connection-mode), the ECP and edge service need to be in the same network or VPC.
+
+![edge-service-mode](_assets/edge-service-mode.png)
 
 ### Direct Connection Mode
 
@@ -22,23 +24,12 @@ Direct connection mode generally refers to the scenario where the cluster and al
 
 <img src="./_assets/edge-service-add.png" style="zoom:60%;" align="middle"> 
 
-### Proxy Mode
+### Agent Mode
 
-If the edge side and ECP are on separate networks and cannot establish a direct connection, it is necessary to install ECP Agent to establish a proxy connection. 
+If the ECP cannot directly access the edge service through the IP address, the edge service needs to be added through agent mode. For specific operation steps, please refer to [Manage edge services by Agent](./edge_agent_management.md).
 
-#### Operation Steps
 
-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 the **Add Type**.
-4. For **Category**, you can choose **eKuiper**, **Neuron**, **NanoMQ**, or **Customize**.
-5. Choose **Proxy** 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.
-9. Click the **Confirm** button to finish the creation. The newly-added edge service is now displayed in the **Edge Service** section. 
-
-## Add Existing Edge Services in Bulk
+## Batch Import Existing Edge Services
 
 ECP supports batch importing of existing edge services in CSV file format. 
 
@@ -55,13 +46,13 @@ The following table provides an overview of the column names of the .csv file an
 
 | Column    | Explanation                       |
 | --------- | --------------------------------- |
-| category  | Edge product type                 |
+| category  | Edge service type                 |
 | name      | Edge service name                 |
-| nodeType  | Direct/Proxy                      |
+| nodeType  | Direct                           |
 | endpoint  | Edge service address              |
-| scheme    | http/https/MQTT                   |
-| agentID   | Edge agent ID, optional           |
+| scheme    | http/https                   |
 | tagName   | Tag name, optional                |
-| serviceID | Edge service ID, optional         |
-| username  | Authentication username, optional |
-| password  | Authentication password, optional |
+
+:::tip
+Batch importing existing edge services only supports the `Direct Connection Mode`.
+:::

ecp/en_US/edge_service/batch_intall.md

@@ -1,13 +1,14 @@
-# Edge Services Batch Installation Docker Mode
+# Host Edge Services By Docker
 
 Based on the ECP platform deployed by Docker, if the hardware of the edge service supports the deployment of Docker containers, edge services can be installed in batches on the ECP platform, shortening the installation and deployment time of edge services, and improving deployment efficiency and consistency.
 
 ## Prerequisites
 
 Before batch installation of edge services, you need to complete the following preparations:
-- [Configure Docker environment](#configuration-docker-environment)
-<!-- - Add [edge service image](../system_admin/resource_config.md#edge service image list) -->
-- Add [edge node](./docker_node.md), the edge service will be installed on the edge node
+- [Configure Docker Environment](#configuration-docker-environment)
+- Configure [Docker Configuration](../system_admin/resource_config.md#docker-configuration) on ECP
+- Add [Edge Service Image List](../system_admin/resource_config.md#edge-service-image-list)
+- Add [edge node](#edge-node-management), the edge service will be installed on the edge node
 
 ### Configuration Docker Environment
 
@@ -16,7 +17,7 @@ edge service is deployed by Docker, so you need to install Docker on the edge no
 After the installation is complete, you need to open the remote access port of the Docker API. The ECP platform manages the life cycle of the edge service through the Docker API, and supports two modes of Docker API to enable TLS authentication and not enable TLS authentication.
 
 
-#### Do not enable TLS authentication
+#### Not enable TLS authentication
 
 1. Find the docker service configuration file, the default is: `/usr/lib/systemd/system/docker.service`, you can see the location of the file through the `systemctl status docker` command.
     ![docker_service](./_assets/docker_service.png)
@@ -41,7 +42,7 @@ After the installation is complete, you need to open the remote access port of t
       This certificate is for testing only.
       Please use a self-signed certificate in a production environment.
       :::
-   2) Modify the IP address in extfile.cnf to the IP address exposed by the edge node that deploys the Docker Engine service externally. This IP address is also the IP address that needs to be entered in ECP when adding [edge nodes](./docker_node.md).
+   2) Modify the IP address in extfile.cnf to the IP address exposed by the edge node that deploys the Docker Engine service externally. This IP address is also the IP address that needs to be entered in ECP when adding [edge nodes](#edge-node-management).
       ![extfile](./_assets/extfile.png)
    3) Execute the gen-docker-cert.sh script to generate the server certificate: server-cert.pem, the default password: `1111`;
       ![gen-docker-cert](./_assets/gen-docker-cert.png)
@@ -63,6 +64,35 @@ After the installation is complete, you need to open the remote access port of t
     upload the certificate file  `ca.pem`, `cert.pem`, `key.pem` to ECP.
    ![docker_mode2](./_assets/docker_mode2.png)
 
+### Edge Node Management
+Through edge node management, you can add, edit, view and delete edge nodes.
+
+#### Edge Node Registration
+Only after the Docker node is registered can the edge service be deployed on the specified Docker node through ECP.
+
+1. Select **Organization**; **Project**;
+2. Click **Edge Management**, select **Edge Node Management**, and click **Create Edge Node**;
+3. Enter the name, IP address, and description of the edge node.
+
+![docker_node_registry](./_assets/docker_node_registry.png)
+
+
+#### Edge Node List Management
+1. Select **Organization**; **Project**;
+2. Click **Edge Management**, select **Edge Node Management**;
+3. Select the node to be managed in the list, you can **edit**, **delete**, **view**, the view button indicates the list of edge services on the node;
+
+![docker_node_list](./_assets/docker_node_list.png)
+
+
+#### List of edge services on the edge node
+After clicking the **View** button on the right of an edge node in the edge node list, you can see the edge service list on the node.
+You can see information such as the status of these edge services in the list.
+
+![docker_node_service_list](./_assets/docker_node_edge_service_list.png)
+
+
+
 ## Batch Install Edge Services
 
 1. Log in as system admin, organization admin, or project admin. Navigate to Workspace - Edge Service page.

ecp/en_US/edge_service/batch_tag.md

@@ -1,4 +1,4 @@
-# Tags and Grouping
+# Tags
 
 ECP provides a tagging feature to classify, organize, and filter edge services. It allows you to group edge services for efficient management, facilitating operations such as managing edge services and batch deployment of edge configurations.
 

ecp/en_US/edge_service/e2c.md

@@ -14,14 +14,19 @@ If authentication is enabled at the managed NeuronEX side, you can configure as
 
   1. Log in to ECP as system admin, organization admin, or project admin. 
   2. Download the public key file: On the **Administration** page, navigate to **System Settings** -> **Resource Settings**. Click to expand the **Managed EdgeService Authentication Configuration**, and download the key file.
- 2. Then Log in to the container or virtual machine where NeuronEX is located, and upload the downloaded public key file to the `etc` directory in the NeuronEX installation directory. 
+  3. Then Log in to the container or virtual machine where NeuronEX is located, and upload the downloaded public key file to the `etc` directory in the NeuronEX installation directory. 
+
+  Taking the NeuronEX container `neuronex-test` installed by Docker as an example, execute the following command on the machine where NeuronEX is deployed:
+
+   ```bash
+   $ docker cp my-ecp.pub neuronex-test:/opt/neuronex/etc/my-ecp.pub
+   ```
+
 
- <!--::: tip-->
- <!--关于 Neuron 认证的详情说明请参考 Neuron 帮助文档，[生成公私钥](https://neugates.io/docs/zh/latest/http-api/jwt.html#%E7%94%9F%E6%88%90%E5%85%AC%E7%A7%81%E9%92%A5) 感觉不需要这块信息-->
 
 ## Test the Authentication Setting
 
-To verify the authentication configuration, try [adding an existing NeuronEX service](./batch_import.md#add-an-existing-edge-service). If the authentication is correctly set up, the Neuron service should be added successfully. You can then click on the service to view its details.
+To verify the authentication configuration, try [adding an existing NeuronEX service](./batch_import.md#add-an-existing-edge-service). If the authentication is correctly set up, the NeuronEX service should be added successfully. You can then click on the service to view its details.
 
 
 ## RSA Signature Authentication