Skip to content

Commit

Permalink
docs: update for license and edge service ops
Browse files Browse the repository at this point in the history
  • Loading branch information
chongyuanyin committed Nov 2, 2023
1 parent a6cf5c7 commit 3d0cfd0
Show file tree
Hide file tree
Showing 12 changed files with 83 additions and 99 deletions.
Binary file modified ecp/en_US/edge_service/_assets/edge-list-groupfilter.png
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-ops.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.
77 changes: 28 additions & 49 deletions ecp/en_US/edge_service/edge_ops.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,31 @@
# Edge Service Management & Operations

ECP integrates the user interfaces of multiple versions of Neuron and eKuiper edge services, allowing for remote connectivity, configuration, monitoring, and management of individual edge services. Additionally, for deployments on Kubernetes, ECP provides a batch management feature for managing multiple hosted edge service instances collectively, further enhancing the efficiency and convenience of edge service management.
ECP integrates the user interfaces of NeuronEX edge services, allowing for remote connectivity, configuration, monitoring, and management of individual edge services. Additionally, for deployments on Kubernetes, ECP provides a batch management feature for managing multiple hosted edge service instances collectively, further enhancing the efficiency and convenience of edge service management.

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

## Manage Edge Services

ECP supports managing Neuron, eKuiper, and NanoMQ on an instance level.
ECP supports managing NeuronEX on an instance level.

### Manage Neuron Instance
### Manage NeuronEX Instance

ECP consolidates the user interfaces of various versions of Neuron. This allows you to set up and manage multiple Neuron instances directly within ECP. Remote configuration of Neuron's northbound applications, southbound devices, groups, tags, drivers, subscriptions, and management plugins can all be easily handled. Moreover, you can monitor real-time data and manage license updates.
ECP consolidates the user interfaces of NeuronEX. This allows you to set up and manage multiple NeuronEX instances directly within ECP and configure data collection and data processing functions remotely.

For the function description of each interface configuration item, refer to the [Neuron Documentation](https://neugates.io/docs/en/latest/).
- Data collection function includes configuration for northbound applications, southbound devices, groups, tags, drivers, subscriptions, and management plugins can all be easily handled. Moreover, you can monitor real-time data and manage license updates.
- Data processing function includes configuration for source tables, rules, extension plugins, files, algorithm packages, functions, and templates.

### Manage eKuiper Instance

ECP integrates user interfaces from various versions of eKuiper, allowing you to manage multiple eKuiper instances directly within the ECP platform. From here, you can remotely configure eKuiper's source tables, rules, extension plugins, files, algorithm packages, functions, and templates.

For the function description of each interface configuration item, refer to the [eKuiper Documentation](https://ekuiper.org/docs/en/latest/).

### Manage NanoMQ Instance

Manage multiple NanoMQ instances directly within the ECP platform. From here, you can import, edit and delete of NanoMQ instance.

For the function description of each interface configuration item, refer to the [NanoMQ Documentation](https://nanomq.io/docs/en/latest/).

### Manage Edge Services in Bulk (Kubernetes Deployment)

ECP offers the capability to manage multiple edge services simultaneously. This section introduces how to efficiently start, stop, restart, and delete multiple edge services in a batch manner.

:::tip
This feature is exclusively applicable to ECP deployed on Kubernetes and for edge services that are hosted within the ECP environment. For more details on the compatibility and restriction, see [Version Compatibility](../others/version_limitations).
:::

To manage the edge services in bulk:

1. Log in as system admin, organization admin, or project admin.

2. On the **Workspace** -> **Edge Services** page, navigate to the **Edge Services** panel.

3. Click to check the target edge services, and select the operation and maintenance operations to be performed in batch, including **Start**, **Stop**, **Restart**, and **Delete**.

Note: The delete operation is irreversible, please proceed with caution.

<img src="./_assets/batch_control.png" style="zoom:100%;" align="middle">

All operations will be logged in the operation audit. To view these logs, navigate to the **Administration** page and click **Audit**. For detailed information about audit, see [Audit](../system_admin/operation_audit.md).
For the function description of each interface configuration item, refer to the [NeuronEX Documentation](https://docs.emqx.com/en/neuronex/latest/).

## Export Edge Services

ECP supports bulk export of edge service data. Operators can export all edge service information for a project into a single local CSV file. Both admins and regular users can execute this batch export feature.
ECP supports bulk export of edge service data. Operators can export some or all edge service information for a project into a single local CSV file. Both admins and regular users can execute this batch export feature.

## Filter Edge Services

ECP enables the filtering of the edge services based on:

- Status filtering: Display only online or offline edge services.
- Product type filtering: Filter services by type, such as eKuiper or Neuron.
- Connection mode filtering: Show services based on their connection mode, either Direct or via Broker.
- Tag filtering: Select services using specific [tags](./batch_tag.md), for example, filter edge services with tags `180` and `Quality Inspection Data Collection`.
- Fuzzy filtering: Search services with similar service names or agent names.
Expand All @@ -68,19 +36,30 @@ Multiple filters can be combined for a more refined search.

## Edit Instance Configurations

In ECP, edge services are either hosted by ECP or externally created but overseen by ECP. For ECP-hosted services, you can edit the **Name** by clicking the edit icon under the **Action** column. For externally managed services, the service name and endpoint can be edited.
In ECP, edge services are either hosted by ECP or externally created but overseen by ECP. For ECP-hosted services, you can edit the **Name** by clicking the **Edit** icon under the **Action** column. For externally managed services, the service name and endpoint can be edited. Please note that only admins can perform the edit action.

## More Operation Actions
## Update Tag Point

Additional operations and maintenance features are available under the **Action** column.
If you want to update tag point for edge services either hosted by ECP or externally created but overseen by ECP, clicking the **Update Node Point** icon under the **Action** column. Hover over the `?` tooltip to get information about already allocated tag point and total tag quota limited in the license, as well as tag point actually used in the NeuronEX. It is required that the updated tag point not less than the point used by the NeuronEX, and not exceed the tag quota of the license. Please note that only admins can perform the edit action.

![tag-allocation](./_assets/edge-tag-allocation.png)

## View Edge Service Details

- By clicking the detail icon, you can access a comprehensive view of the edge service.
You can click the **Details** icon under the **Action** column to view the detailed information of the edge service. Both admins and regular users can execute this batch export feature.

- By clicking the monitor icon, you can observe the operational status of the service. For more information on monitoring, refer to [Monitor Edge Services](../monitor/monitor_edge.md).
## View Edge Service Log

You can click the **Log** icon under the **Action** column to view the logs of the edge service. Both admins and regular users can execute this batch export feature.

## Delete Edge Service

You can click the **Delete** icon under the **Action** column to delete a single edge service. You can also click **Batch** -> **Delete** to delete multiple edge services:

Additional operations and maintenance features are available under the **Action** column.

- For viewing running logs of the instance, click the more icon and select Log.
- If the instance is hosted in ECP, it will be completely removed.
- If it's managed by ECP, only its registration information in ECP will be deleted, leaving the edge instance unaffected.

- You can also delete the instance by clicking the delete icon.
- If the instance is hosted in ECP, it will be completely removed.
- If it's managed by ECP, only its registration information in ECP will be deleted, leaving the edge instance unaffected.
Please note that only admins can perform the edit action.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 10 additions & 3 deletions ecp/en_US/install/license_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ After completing the installation and deployment, it is necessary to configure t

## ECP License

ECP utilizes a floating license mechanism that enables multiple EMQX clusters to share a centralized license and connection pool. This approach allows for efficient resource allocation across various stages (such as development, testing, and production) by eliminating the need for separate licenses and connection counts for each EMQX cluster.
ECP utilizes a floating license mechanism that enables multiple EMQX clusters to share a centralized license and connection pool, and multiple NeuronEX instances to share a tag pool. This approach allows for efficient resource allocation across various stages (such as development, testing, and production) by eliminating the need for separate licenses and connection counts for each EMQX cluster.

## Apply for License

ECP provides both trial and commercial licenses. The trial version allows customers to use the EMQX product suite free of charge for a 15-day period, with a concurrent connection limit of 10,000 connections. To request a trial license, please contact us using the sales email address, and we will promptly send it to you.
ECP provides both trial and commercial licenses. To request a trial license, please contact us using the sales email address, and we will promptly send it to you.

For commercial licenses, please contact EMQX sales for detailed information and assistance. They will provide you with the necessary details regarding commercial licensing options, pricing, and any additional information you may require.

Expand All @@ -26,7 +26,7 @@ ECP provides two main tabs: **Administration** and **Workspace**.
- The **Administration** tab allows you to perform administrative tasks and system-level settings. Within this tab, you can create organizations and projects, configure resources, set up email servers, manage notifications, specify language preferences, and manage licenses.
- The **Workspace** tab is designed for operational tasks and managing specific functionalities of the ECP platform. Within this tab, you can manage EMQX clusters, oversee edge services, configure monitoring and alert rules, and access logs for troubleshooting and analysis purposes.

To configure the license, click **License Management** on the left navigation menu.
To configure the license, click **License Management** on the left navigation menu, and enter **License Config** page.

<img src="./_assets/manager-license-info.png" alt="License" style="zoom:50%;" />

Expand All @@ -37,6 +37,7 @@ Below is the description of each field
- **Customer Email**: Customer email address.
- **Start Date**: The date when the license becomes effective.
- **Expiration Date**: The date when the license expires.
- **Tag Point**: The maximum number of tags allowed by the license, along with the number of already allocated tags.
- **Cluster Count**: The maximum number of clusters allowed by the license, along with the number of clusters already created.
- **Connection Count**: The maximum number of connections allowed by the license, along with the number of connections already established.
- **Edge Service Count**: The maximum number of edge services allowed by the license, along with the number of edge services already created and managed.
Expand All @@ -46,6 +47,7 @@ Below is the description of each field
To update the license, simply select and upload a new license file. The system will automatically update the following based on the new license:

- Subscription duration (for both ECP and EMQX)
- Tag point
- Connection number
- EMQX Cluster number
- Edge services limit
Expand All @@ -54,3 +56,8 @@ This ensures that the license information accurately reflects the updated limits

<img src="./_assets/manager-license-update.png" alt="license-update" style="zoom:50%;" />

## Configure License Tag Point

To view and update device tag point for edge services, click **License Management** on the left navigation menu, and enter **Node Config** page. This page provides you with an option to check device tag point by organization, project or tags. To configure device tag point for an edge service, simply click the **Update Node Point** button and set the point on the prompt dialog.

![license-tag](./_assets/allocate-license-tag.png)
Binary file modified ecp/zh_CN/edge_service/_assets/edge-list-groupfilter.png
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-ops.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.
71 changes: 30 additions & 41 deletions ecp/zh_CN/edge_service/edge_ops.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,31 @@
# 边缘服务管理运维

ECP 中集成了多个版本的 Neuron 和 eKuiper 的用户界面,允许用户远程连接、配置、监控和管理各个边缘服务。此外,在由 Kubernetes 部署的 ECP 平台中,您还可通过批量管理功能,方便集中管理多个边缘服务实例,进一步提升边缘服务管理的效率。
ECP 中集成了NeuronEX 的用户界面,允许用户远程连接、配置、监控和管理各个边缘服务。此外,在由 Kubernetes 部署的 ECP 平台中,您还可通过批量管理功能,方便集中管理多个边缘服务实例,进一步提升边缘服务管理的效率。

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

## 管理边缘服务实例

### 管理 Neuron 实例
### 管理 NeuronEX 实例

ECP 集成了多版本的 Neuron UI,您可以在 ECP 平台配置多个 Neuron 实例,远程配置 Neuron 的北向应用、南向设备、Group、Tag、驱动、订阅、管理插件、监控实时数据和更新许可证。
ECP 集成了 NeuronEX UI,您可以在 ECP 平台配置多个 NeuronEX 实例,对 NeuronEX 的数采功能和数据处理功能进行远程配置:

关于各界面配置项的功能说明,参考 [Neuron 在线文档](https://neugates.io/docs/zh/latest/)

### 管理 eKuiper 实例

ECP 集成了多版本的 eKuiper UI,您可以在 ECP 平台配置多个 eKuiper 实例,远程配置 eKuiper 的源表、规则、扩展插件、文件、算法包、函数和模版。

关于各界面配置项的功能说明,参考 [eKuiper 在线文档](https://ekuiper.org/docs/zh/latest/)

## 批量管理边缘服务实例(Kubernetes 部署)

批量控制是指对边缘服务进行批量启动、停止、重启、删除的操作。

:::tip
关于批量配置的使用限制,参见[系统使用限制](../others/known_limitations)[版本兼容性限制](../others/version_limitations)
:::

如希望执行批量管理操作:

1. 以系统/组织/项目管理员的身份登录 ECP。

2.**工作台** -> **边缘服务**管理页,找到边缘服务列表部分。

3. 点击勾选目标边缘服务实例,点击操作栏的更多图标,选择待执行的批量操作,如重启、停止、升级、删除等。

注意:删除操作不可撤销,请谨慎操作。

<img src="./_assets/batch_control.png" style="zoom:100%;" align="middle">
- 数采功能的管理包括北向应用、南向设备、Group、Tag、驱动、订阅、管理插件、监控实时数据和更新许可证。

- 数据处理功能的管理包括源表、规则、扩展插件、文件、算法包、函数和模版。

各配置项的功能说明,请参考 [NeuronEX 在线文档](https://docs.emqx.com/zh/neuronex/latest/)

## 导出边缘服务列表

为了满足企业客户,ECP 提供了批量导出边缘服务功能,导出为该项目下所有的边缘服务信息并以 CSV 文件存储在本地。注意:管理员和普通用户均可执行导出操作。
为了满足企业客户需求,ECP 提供了批量导出边缘服务功能,可将该项目下部分或所有的边缘服务信息以 CSV 文件格式导出并存储在本地。注意:管理员和普通用户均可执行导出操作。


## 筛选边缘服务

ECP 还提供了针对边缘服务的筛选功能:

- 状态:根据在线/离线状态进行筛选
- 产品类别:针对产品类别进行筛选,如 eKuiper 或 Neuron
- 连接方式:直连模式,或代理模式
- 标签筛选:针对选择业务标签进行筛选,如筛选同时包含标签 `180``质检数采` 的边缘服务。

Expand All @@ -62,15 +37,29 @@ ECP 还提供了针对边缘服务的筛选功能:

## 编辑实例配置

对于由 ECP 托管或纳管的边缘服务实例,您均可点击服务实例后**更多**图标,并选择**编辑**。对于由 ECP 安装的边缘服务,您可修改**名称**;对于由 ECP 纳管的边缘服务,可以修改**类型****连接方式****名称****边缘服务地址**
对于由 ECP 托管或纳管的边缘服务实例,您均可点击服务实例后**更多**图标,并选择**编辑**。对于由 ECP 安装的边缘服务,您可修改**名称**;对于由 ECP 纳管的边缘服务,可以修改**类型****连接方式****名称****边缘服务地址**。注意:仅管理员可执行编辑操作。

## 修改设备点位数

如果需要对 ECP 托管或纳管的在线边缘服务实例所分配的设备点位数进行修改,您可以点击服务实例后**更多**图标,并选择**修改点位数**。在弹出对话框中,将鼠标悬浮在 `?` 提示信息处,可查看当前已分配的点位数及许可证支持的总点位数,以及在该边缘服务中已经实际配置使用的点位数。在修改当前边缘服务点位数时,请确保新设置的点位数不少于实际配置使用的点位数,并且不会超过许可证的点位数限额。

![tag-allocation](./_assets/edge-tag-allocation.png)

注意:仅管理员可执行修改点位数操作。

## 查看边缘服务详情

您可以点击服务实例后**操作**栏的**详情**图标,查看边缘服务的详细信息。注意:管理员和普通用户均可执行查看详情操作。

## 查看日志

您可以点击服务实例后**更多**图标,并选择**日志**,查看该边缘服务实例的运行日志。注意:管理员和普通用户均可执行查看详情操作。

## 删除边缘服务

## 更多运维操作
您可以通过点击服务实例后**更多**图标,并选择**删除**操作,对单个边缘服务进行删除。或者通过点击**批量操作** -> **删除**,对多个边缘服务进行指删除:

ECP 在各边缘服务实例的操作列还提供了更多的运维操作:
- 对于由 ECP 创建的边缘服务实例,点击删除后,该实例将被完全删除。
- 对于由 ECP 纳管的边缘服务实例,点击删除后,ECP 会将该实例的注册信息删除,不会直接删除该实例。

- 点击详情图标,可查看边缘服务的详情信息。
- 点击监控图标,可查看边缘服务的运行状态,关于监控的更多信息,见[边缘服务监控](../monitor/monitor_edge.md)
- 如希望查看边缘服务实例的运行日志,可点击更多图标,并选择**日志**
- 此外,您还可删除边缘服务实例:
- 对于由 ECP 创建的边缘服务实例,点击删除后,该实例将被完全删除。
- 对于由 ECP 纳管的边缘服务实例,点击删除后,ECP 会将该实例的注册信息删除,不会直接删除该实例。
注意:仅管理员可执行删除操作。
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 3d0cfd0

Please sign in to comment.