Skip to content

Commit

Permalink
Merge pull request #26 from emqx/clone
Browse files Browse the repository at this point in the history
update doc for edge service clone
  • Loading branch information
QQDQ authored Nov 4, 2023
2 parents a6cf5c7 + 151e6f2 commit 1d5361b
Show file tree
Hide file tree
Showing 14 changed files with 16 additions and 15 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/en_US/edge_service/_assets/edge-list-distribution-result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions ecp/en_US/edge_service/batch_distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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

Expand All @@ -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.
Expand All @@ -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.
Expand Down
1 change: 0 additions & 1 deletion ecp/en_US/others/known_limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
| :--------------| :-----------------------------------------------------------|
|Manage edge services|Supports up to 400 edge services.|
|Batch configuration deployment (Global Overwrite)|1. At most one batch configuration deployment job can be running within one project. <!--to confirm--><br/><br/>2. A template can support up to 50 parameters.<br/><br/>3. At most 200 edge services can be configured with this batch configuration deployment job.|
|Batch configuration deployment (Local Update)|At most one batch configuration deployment job can be running within one project.|
|Batch install of edge services|1. At most one batch install job can be running within one project. <br/>2. At most 200 edge services can be installed in bulk<br/>3. Only direct connection mode is supported|
|Batch upgrade of edge services|At most one batch upgrade job can be running within one project.|
| Tag management | 1. One service can have up to 10 tags.<br/><br/> 2. One project can support up to 100 tags. |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/zh_CN/edge_service/_assets/edge-list-distribution-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 9 additions & 7 deletions ecp/zh_CN/edge_service/batch_distribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

在边缘计算环境中,边缘设备通常运行着多种边缘软件,而这些软件需要根据应用程序和业务需求进行不同的配置。

ECP 提供了配置的批量下发功能,支持将相同或类似的配置信息同时下发给多个边缘设备上的软件( Neuron、eKuiper )
ECP 提供了配置的批量下发功能,支持将相同或类似的配置信息同时下发给多个边缘设备上的边缘服务

配置的批量下发功能可以帮助管理员快速实现一致和可靠的配置策略,提高边缘计算环境的稳定性和可靠性,降低因配置错误或不一致导致的故障和损失。

Expand All @@ -23,6 +23,12 @@ ECP 提供了配置的批量下发功能,支持将相同或类似的配置信

![choose](./_assets/edge-list-distribution-choose.png)

## 功能选择

选择 `数采功能``数据处理功能`,将相应功能的配置批量下发到其他边缘服务。

![function](./_assets/edge-list-distribution-function.png)

## 模版编辑

使用 **\$\{\}** 参数化 Json 标签、数字、字符串、或其他文本。
Expand All @@ -42,21 +48,17 @@ ECP 提供了配置的批量下发功能,支持将相同或类似的配置信
参数化后:

```
"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} \"}}"
```

编辑完成后,点击**下一步**进入选择边缘服务页。

## 选择边缘服务

**选择边缘服务**页,您可基于参数名称、EndPoint、版本、或标签快速定位待同步参数的服务实例,然后点击实例前的复选框快速选择。
**选择边缘服务**页,您可基于边缘服务名称、EndPoint、版本、或标签快速定位待同步参数的服务实例,然后点击实例前的复选框快速选择。

![template](./_assets/edge-list-distribution-edit.png)

:::tip
您在此页面选择的边缘服务类型应与模版中指定的类型相同。
:::

## 参数编辑

**参数编辑**页,您可批量为多个边缘服务的参数赋值,提高边缘配置的效率。
Expand Down
1 change: 0 additions & 1 deletion ecp/zh_CN/others/known_limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
| :--------------| :-----------------------------------------------------------|
|ECP 管理边缘服务|支持最多400个边缘服务|
|边缘配置批量下发-全局覆盖|1 边缘配置批量下发在系统里表现为一个任务,同一个**项目**里,最多只能有一个配置任务执行下发,大于一个会报错<br/>2 模版中最多支持50个参数<br/>3 最多支持200个边缘服务同时下发配置|
|边缘配置批量下发-局部配置增量修改|边缘配置批量下发在系统里表现为一个任务,同一个**项目**里,最多只能有一个配置任务执行下发,大于一个会报错|
|批量安装边缘服务|1 批量安装边缘服务在系统里表现为一个任务,**系统**内最多只能有一个安装任务,大于一个会报错<br/>2 最多支持同时安装200个边缘服务<br/>3 只支持直连模式|
|批量升级边缘服务|批量升级边缘服务在系统里表现为一个任务,同一个**项目**里,最多只能有一个升级任务执行,大于一个会报错|
| 标签管理 | 1 一个服务最多可以有10个标签,多于10个标签会保存失败<br/> 2 一个项目最多可支持100个标签,多于100个标签会保存失败 |
Expand Down

0 comments on commit 1d5361b

Please sign in to comment.