Przeglądaj źródła

fix(doc): clarify eKuiper manager installation

Signed-off-by: Jiyong Huang <huangjy@emqx.io>
Jiyong Huang 2 lat temu
rodzic
commit
1db8ba2b84

+ 0 - 1
docs/en_US/installation.md

@@ -51,7 +51,6 @@ Please make sure docker compose has installed before running.
       volumes:
         - /tmp/data:/kuiper/data
         - /tmp/log:/kuiper/log
-        - /tmp/plugins:/kuiper/plugins
       environment:
         MQTT_SOURCE__DEFAULT__SERVER: "tcp://broker.emqx.io:1883"
         KUIPER__BASIC__CONSOLELOG: "true"

+ 10 - 5
docs/en_US/operation/manager-ui/overview.md

@@ -16,12 +16,16 @@ From eKuiper version 0.9.1, whenever a new version of eKuiper is released, the c
 
 * UI end: a visual interface, easy for users to operate
 * Kuiper-manager: Management console, which essentially is a reverse HTTP proxy service, providing the services of user management, permission verification. It can be deployed in the cloud or at the edge
-* eKuiper instance: managed eKuiper node instance, Kuiper-manager can manage multiple eKuiper nodes at the same time
+* eKuiper instance: managed eKuiper node instance, eKuiper-manager can manage multiple eKuiper nodes at the same time
 
 ![construct](./resources/arch.png)
 
 ## Install the management console
 
+In production, eKuiper is usually installed at the edge and eKuiper manager is installed at the gateway or cloud to manage one or more eKuiper instances at the edge. In this case, the two are deployed on different physical machines and need to be deployed separately. This chapter will use this approach for deployment.
+
+During test, it is more handy to use docker compose to install and deploy both products with one click. Please refer to [Run with Management Console](../../installation.md#running-ekuiper-with-management-console) for details.
+
 ### Install eKuiper
 
 - Pull eKuiper's Docker image from [Docker Image Library](https://hub.docker.com/r/lfedge/ekuiper/tags). Since it is required to install the plugin in this article, you must use the `ekuiper:1.8-slim` image (`ekuiper:1.8-alpine` image is relatively small and easy to install, but due to the lack of some necessary library files, the plug-in cannot run normally. The `ekuiper:1.8-dev` image is the development version, which is suitable for use in the development phase).
@@ -62,17 +66,18 @@ From eKuiper version 0.9.1, whenever a new version of eKuiper is released, the c
   docker pull emqx/ekuiper-manager:1.8
   ```
 
-- Run the Kuiper-manager container and expose port 9082.
+- Run the Kuiper-manager container and expose port 9082. Whereas DEFAULT_EKUIPER_ENDPOINT can be used to specify the default managed eKuiper address, which should be set to the actual ip of the machine where the eKuiper is located.
 
   ```shell
-  docker run --name kuiperManager -d -p 9082:9082 -e DEFAULT_EKUIPER_ENDPOINT="http://127.0.0.1:9081" emqx/ekuiper-manager:1.8
+  docker run --name kuiperManager -d -p 9082:9082 -e DEFAULT_EKUIPER_ENDPOINT="	
+http://$your_ekuiper_host:9081" emqx/ekuiper-manager:1.8
   ```
 
 ## Getting started
 
-### Login to kuiper-manager
+### Login to ekuiper-manager
 
-You need to provide the address, user name, and password of kuiper-manager when logging in, which is shown below:
+You need to provide the address, username, and password of kuiper-manager when logging in, which is shown below:
 
 * Address: `http://$yourhost:9082`
 

+ 0 - 1
docs/zh_CN/installation.md

@@ -51,7 +51,6 @@ eKuiper manager 是一个免费的 eKuiper 管理控制台,以 Docker 镜像
       volumes:
         - /tmp/data:/kuiper/data
         - /tmp/log:/kuiper/log
-        - /tmp/plugins:/kuiper/plugins
       environment:
         MQTT_SOURCE__DEFAULT__SERVER: "tcp://broker.emqx.io:1883"
         KUIPER__BASIC__CONSOLELOG: "true"

+ 6 - 3
docs/zh_CN/operation/manager-ui/overview.md

@@ -16,12 +16,15 @@
 
 * UI 端:可视化的界面,便于用户操作
 * Kuiper-manager:管理控制台,本质是一个反向 HTTP 代理服务,提供用户管理,权限验证等服务。既可以部署在云端,也可以部署在边缘端
-* eKuiper 实例,被管理的 eKuiper 节点实例,Kuiper-manager 可以同时管理多个 eKuiper 节点
+* eKuiper 实例,被管理的 eKuiper 节点实例,eKuiper-manager 可以同时管理多个 eKuiper 节点
 
 ![construct](./resources/arch.png)
 
 ## 安装管理控制台
 
+在实际场景中,eKuiper 通常安装在边缘端,而 eKuiper manager 安装在网关或云端,负责管理一个或多个边缘端的 eKuiper。这种情况下,两者部署在不同的物理机器上,需要分开部署。本章将采用此种方式进行部署。
+在测试场景种,用户可采用 docker compose 的方式一键安装部署,详情请参考[使用管理控制台运行](../../installation.md#使用管理控制台运行)。
+
 ### 安装 eKuiper
 
 - 从 [Docker 镜像库](https://hub.docker.com/r/lfedge/ekuiper/tags)拉取 eKuiper 的 Docker 镜像。由于本文中要安装插件,必须使用`ekuiper:1.8-slim`镜像(`ekuiper:1.8-alpine` 镜像比较小,安装比较方便,但是由于缺少一些必要的库文件,插件无法正常运行;而 `ekuiper:1.8-dev` 镜像是开发版本的镜像,适合于开发阶段使用)。
@@ -62,10 +65,10 @@
   docker pull emqx/ekuiper-manager:1.8
   ```
 
-- 运行 Kuiper-manager 容器并暴露 9082 端口。
+- 运行 eKuiper-manager 容器并暴露 9082 端口。其中,DEFAULT_EKUIPER_ENDPOINT 可用于指定默认管理的 eKuiper 地址,此处应设置成实际的 eKuiper 所在机器的 ip 。
 
   ```shell
-  docker run --name kuiperManager -d -p 9082:9082 -e DEFAULT_EKUIPER_ENDPOINT="http://127.0.0.1:9081" emqx/ekuiper-manager:1.8
+  docker run --name kuiperManager -d -p 9082:9082 -e DEFAULT_EKUIPER_ENDPOINT="http://$your_ekuiper_host:9081" emqx/ekuiper-manager:1.8
   ```
 
 ## 开始使用