emqx/ekuiper-manager

eKuiper Manager Docker镜像文档

镜像概述

eKuiper manager是由EMQ提供的eKuiper首选管理Web控制台，用户可通过它管理一个至多个eKuiper实例，完全免费使用。该控制台支持eKuiper规则的全生命周期管理，只要能连接到eKuiper的REST端口，即可与eKuiper部署在同一机器或独立机器上。

核心功能与架构

核心功能

• 提供可视化Web界面，便于用户操作
• 支持多eKuiper节点实例管理
• 实现用户管理与权限验证
• 管理eKuiper规则的创建、编辑、启动、停止、删除等全生命周期操作

架构设计

• UI端：可视化操作界面，方便用户交互
• eKuiper manager：管理控制台，本质是反向HTTP代理服务，提供用户管理和权限验证，可部署在云端或边缘端
• eKuiper实例：被管理的eKuiper节点实例，eKuiper manager可同时管理多个节点

!架构图

使用场景

适用于需要通过Web界面管理eKuiper规则和实例的场景，包括但不限于：

• 边缘计算数据处理规则管理
• 多eKuiper节点集中管控
• 规则生命周期可视化管理
• 无需编写代码即可配置数据处理逻辑

安装与部署

前提条件

• 已安装Docker和Docker Compose（推荐使用Docker Compose部署）

拉取镜像

shell
docker pull emqx/ekuiper-manager:1.8.0
docker pull lfedge/ekuiper:1.8.0

使用方法

使用Docker Compose部署（推荐）

创建docker-compose.yml文件，内容如下：

yaml
version: '3.4'

services:
  manager:
    image: emqx/ekuiper-manager:1.8.0
    container_name: manager
    ports:
      - "9082:9082"  # 管理控制台端口
    restart: unless-stopped
    volumes:
      - /tmp/manager_data:/ekuiper-manager/data  # 持久化管理数据
    environment:
      DEFAULT_EKUIPER_ENDPOINT: "http://ekuiper:9081"  # 默认eKuiper实例地址
  ekuiper:
    image: lfedge/ekuiper:1.8.0
    ports:
      - "9081:9081"  # eKuiper REST API端口
    container_name: ekuiper
    hostname: ekuiper
    restart: unless-stopped
    user: root
    volumes:
      - /tmp/data:/kuiper/data  # eKuiper数据持久化
      - /tmp/log:/kuiper/log    # eKuiper日志持久化
    environment:
      MQTT_SOURCE__DEFAULT__SERVER: "tcp://broker.emqx.io:1883"  # 默认MQTT源服务器
      KUIPER__BASIC__CONSOLELOG: "true"  # 启用控制台日志
      KUIPER__BASIC__IGNORECASE: "false"  # 不忽略大小写

启动服务：

shell
docker-compose up -d

直接使用Docker部署

部署eKuiper实例

shell
docker run -d -p 9081:9081 --name kuiper \
  -e MQTT_SOURCE__DEFAULT__SERVER="tcp://broker.emqx.io:1883" \
  lfedge/ekuiper:1.8.0

部署eKuiper manager

shell
docker run -d -p 9082:9082 \
  -e DEFAULT_EKUIPER_ENDPOINT="http://127.0.0.1:9081" \
  emqx/ekuiper-manager:1.8.0

登录与配置

登录控制台

1. 访问地址：http://$yourhost:9082（将$yourhost替换为部署主机IP）
2. 用户名：admin
3. 密码：public

!登录界面

创建eKuiper服务

通过上述步骤已配置默认eKuiper实例。如需修改eKuiper实例地址，可更改DEFAULT_EKUIPER_ENDPOINT环境变量并重启eKuiper manager。

!添加服务

创建和管理规则

前提条件

需要MQTT broker作为eKuiper规则的数据源。推荐使用EMQ，或使用公共MQTT测试服务器tcp://broker.emqx.io:1883。

场景说明

示例场景：通过MQTT接收传感器的温度和湿度数据，当5秒时间窗口内平均温度超过30°C时触发告警。

定义流（Stream）

1. 在"源/流"页面，点击"创建流"按钮
2. 创建名为demo的流，配置如下：
   • 数据源（DATASOURCE）：MQTT主题demo
   • MQTT服务器：tcp://broker.emqx.io:1883（如需使用其他服务器，可点击"添加配置键"设置新配置）

!创建流

3. 点击"提交"，在流列表中可看到创建的demo流。

创建规则

1. 进入"规则"页面，点击"创建规则"

2. 填写规则ID、名称，并输入SQL：

   sql
   SELECT count(*), avg(temperature) AS avg_temp, max(humidity) AS max_hum 
   FROM demo 
   GROUP BY TUMBLINGWINDOW(ss, 5) 
   HAVING avg_temp > 30
   

   !创建规则

3. 添加MQTT动作：

   • 选择"sink类型"为mqtt
   • 配置MQTT broker地址、结果主题（如result/rule1）
   • （可选）配置ClientID、用户名、密码等

   !MQTT动作配置

4. 点击"提交"，规则列表中会显示创建的myRule规则并自动启动。

管理规则

在"规则"页面可查看所有规则及其状态：

!规则列表

• 状态管理：通过开关按钮启动/停止规则
• 查看状态：点击"状态"查看规则运行状态和指标（数据流入时指标会更新）

!规则状态

• 操作：支持编辑、复制和删除规则

环境变量说明

eKuiper manager环境变量

• DEFAULT_EKUIPER_ENDPOINT：默认eKuiper实例的REST API地址（如http://ekuiper:9081）

eKuiper环境变量

• MQTT_SOURCE__DEFAULT__SERVER：默认MQTT数据源服务器地址
• KUIPER__BASIC__CONSOLELOG：是否启用控制台日志（true/false）
• KUIPER__BASIC__IGNORECASE：是否忽略SQL大小写（true/false）