diff --git a/ecp/directory.json b/ecp/directory.json index bef59de..3cc1b71 100644 --- a/ecp/directory.json +++ b/ecp/directory.json @@ -289,8 +289,8 @@ "path": "edge_service/batch_upgrade" }, { - "title": "Batch Configuration Distribution", - "path": "edge_service/batch_distribution" + "title": "Edge Config Management and Delivery", + "path": "edge_service/edge_resource_management" }, { "title": "Edge Service Management & Operations", diff --git a/ecp/en_US/edge_service/_assets/edge-ext-create.png b/ecp/en_US/edge_service/_assets/edge-ext-create.png new file mode 100644 index 0000000..0aa1318 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-ext-create.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-ext-deliver-1.png b/ecp/en_US/edge_service/_assets/edge-ext-deliver-1.png new file mode 100644 index 0000000..6966136 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-ext-deliver-1.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-ext-deliver-2.png b/ecp/en_US/edge_service/_assets/edge-ext-deliver-2.png new file mode 100644 index 0000000..eb01965 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-ext-deliver-2.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-ext-deliver-audit.png b/ecp/en_US/edge_service/_assets/edge-ext-deliver-audit.png new file mode 100644 index 0000000..1a5d5af Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-ext-deliver-audit.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-ext-deliver.png b/ecp/en_US/edge_service/_assets/edge-ext-deliver.png new file mode 100644 index 0000000..32f48ab Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-ext-deliver.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-create.png b/ecp/en_US/edge_service/_assets/edge-template-create.png new file mode 100644 index 0000000..02f481b Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-create.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-deliver-1.png b/ecp/en_US/edge_service/_assets/edge-template-deliver-1.png new file mode 100644 index 0000000..6a2d104 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-deliver-1.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-deliver-2.png b/ecp/en_US/edge_service/_assets/edge-template-deliver-2.png new file mode 100644 index 0000000..a3bca5b Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-deliver-2.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-deliver-3.png b/ecp/en_US/edge_service/_assets/edge-template-deliver-3.png new file mode 100644 index 0000000..801f618 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-deliver-3.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-deliver-audit.png b/ecp/en_US/edge_service/_assets/edge-template-deliver-audit.png new file mode 100644 index 0000000..95e881e Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-deliver-audit.png differ diff --git a/ecp/en_US/edge_service/_assets/edge-template-deliver.png b/ecp/en_US/edge_service/_assets/edge-template-deliver.png new file mode 100644 index 0000000..0722b83 Binary files /dev/null and b/ecp/en_US/edge_service/_assets/edge-template-deliver.png differ diff --git a/ecp/en_US/edge_service/edge_resource_management.md b/ecp/en_US/edge_service/edge_resource_management.md new file mode 100644 index 0000000..2cbb556 --- /dev/null +++ b/ecp/en_US/edge_service/edge_resource_management.md @@ -0,0 +1,87 @@ +# Edge Config Management and Delivery + +In the edge computing environment, various softwares run on edge devices, each requiring custom configurations to meet specific business requirements. + +With ECP, you can easily deliver identical configurations to multiple edge devices. This approach helps administrators apply rapid, consistent and reliable configuration strategies, minimize configuration errors and redundant tasks, in order to boost the stability and reliability of the edge computing environment. + +:::tip + +ECP sets restrictions for system protection purposes. For details, please refer to [System Usage Restrictions](../others/known_limitations) and [Version Compatibility](../others/version_limitations). +::: + +## Manage and Deliver Config Template + +ECP supports creating config templates for NeuronEX's rules or southbound devices, as well as delivering these templates to edge services. + +### Create Config Template + +Log in as system admins, organization admins, or project admins, navigate to **Workspace** -> **Edge Config**, and enter into the **Template** tab, then click the **Add Config Template** button. + +![template-create](./_assets/edge-template-create.png) + +You can choose "Rule" or "South Device" for **Template Type**. Template file can be exported from NeuronEX's rule or southbound driver pages, and uploaded with further modifications. Please note that template names must be unique. + +After creating a template, you can further edit it, export its content, or delete the template. + +### Deliver Template + +Click the **Template Distribution** button in the **Action** column to open the template delivery window. + +![template-deliver](./_assets/edge-template-deliver.png) + +In the pop-up window, you can make necessary modifications to the template content. The modifications will only affect the current delivery and will not be saved in the template. + +![template-deliver-edit](./_assets/edge-template-deliver-1.png) + +Click the **Next** button to choose the target edge services to which the template will be delivered. You can quickly locate service instances by filtering on their name, endpoint, version or tags and select them by checking the checkbox. + +![template-deliver-target](./_assets/edge-template-deliver-2.png) + +Click the **Implement** button, and ECP will deliver the template to the specified target edge services. The delivery status will be displayed on the results page in real-time. Please wait on this page for a moment to view the following results: + +- The total number of edge service instances to be configured, the count of successful delivery, and the counf of failed delivery, will be displayed. A `green circle` indicates a successful delivery, while a `red exclamation mark` indicates a failed one. + +- Failure reasons can be checked in the **Reason** column. + +![template-deliver-result](./_assets/edge-template-deliver-3.png) + +To review the previous delivery results, you can search from the **Audit** page under the **Administration** menu. + +![template-deliver-audit](./_assets/edge-template-deliver-audit.png) + +## Manage and Deliver Plugin + +ECP supports delivering extensions to edge services. + +### Create Plugin + +Log in as system admins, organization admins, or project admins, navigate to **Workspace** -> **Edge Config**, and enter into the **Plugin Management** tab, then click the **Add Plugin** button. + +![ext-create](./_assets/edge-ext-create.png) + +Portable plugin is supported for now. To get information of devloping a portable plugin, please refer to [Portable plugin development](https://docs.emqx.com/en/neuronex/latest/streaming-processing/extension.html#portable-plugin-development). + +The uploaded plugin package must be in ZIP format, and the JSON file within the plugin package must match the input plugin name to ensure successful delivery. Duplicate creation of plugin packages with identical content is not supported. + +### Deliver Plugin + +Click the **Plugin Distribution** button in the **Action** column to open the plugin delivery window. + +![ext-deliver](./_assets/edge-ext-deliver.png) + +In the pop-up window, you can choose the target edge services to which the plugin will be delivered. Locate service instances by filtering on their name, endpoint, version or tags and then select them by checking the checkbox. + +![ext-deliver-target](./_assets/edge-ext-deliver-1.png) + +Click the **Implement** button, and ECP will deliver the plugin to the specified target edge services. The delivery status will be displayed on the results page in real-time. Please wait on this page for a moment to view the following results: + +- The total number of edge service instances to be configured, the count of successful delivery, and the counf of failed delivery, will be displayed. A `green circle` indicates a successful delivery, while a `red exclamation mark` indicates a failed one. + +- Failure reasons can be checked in the **Reason** column. + +![ext-deliver-result](./_assets/edge-ext-deliver-2.png) + +To review the previous delivery results, you can search from the **Audit** page under the **Administration** menu. + +![ext-deliver-audit](./_assets/edge-ext-deliver-audit.png) + diff --git a/ecp/en_US/edge_service/introduction.md b/ecp/en_US/edge_service/introduction.md index 19951ce..50bee80 100644 --- a/ecp/en_US/edge_service/introduction.md +++ b/ecp/en_US/edge_service/introduction.md @@ -33,7 +33,7 @@ Below are topics that will be covered in this chapter: - [Authenticate Edge Services](./e2c) - [Tags and Grouping](./batch_tag) - [Upgrade Edge Services](./batch_upgrade) -- [Batch Configurations Distribution](./batch_distribution) +- [Edge Config Management and Delivery](./edge_resource_management) - [Edge Service Management & Operations](./edge_ops)