kapua/kapua-events-broker

Eclipse Kapua Service Event Broker 镜像文档

一、镜像概述和主要用途

1.1 概述

本镜像用于运行 Event Broker 服务，该服务是 Eclipse Kapua 生态系统的核心组件之一，负责在 Kapua 各服务之间进行事件的接收、路由与分发，实现服务间的解耦通信。

1.2 主要用途

• 作为 Kapua 服务架构中的事件总线，连接不同功能模块（如设备管理、数据处理、规则引擎等）
• 接收来自源服务的事件消息，并根据预设规则路由至目标服务
• 确保 Kapua 服务集群内事件传递的可靠性与实时性

二、核心功能和特性

2.1 核心功能

• 事件路由：支持基于事件类型、源服务标识、目标服务标识的动态路由
• 服务解耦：通过事件中间件模式，降低 Kapua 各服务间的直接依赖
• 消息分发：支持一对一、一对多的事件广播机制
• 事件持久化：可选配置事件持久化存储，避免服务重启导致的事件丢失（需依赖外部存储组件）

2.2 特性

• 轻量级设计，适配容器化部署
• 支持水平扩展，可通过多实例部署提升事件处理吞吐量
• 兼容 Kapua 服务通信协议（如 AMQP、MQTT 等，具体取决于 Kapua 版本）
• 低延迟事件传递，满足实时性要求

三、使用场景和适用范围

3.1 典型使用场景

• Kapua 服务集成：在 Kapua 平台部署中，连接设备接入服务、数据存储服务、规则引擎服务等模块
• 微服务架构通信：在基于 Kapua 的微服务架构中，实现跨服务的异步事件通知（如设备状态变更、数据上报触发规则执行等）
• 集群化部署：在 Kapua 分布式集群中，作为跨节点事件同步的枢纽

3.2 适用范围

• Eclipse Kapua 平台 v1.x 及以上版本的服务集群
• 基于容器化部署的 Kapua 应用（Docker、Kubernetes 等环境）
• 需要实现服务间松耦合通信的 Kapua 二次开发场景

四、使用方法和配置说明

4.1 基本使用（Docker Run）

通过 docker run 命令启动容器，示例如下：

bash
docker run -d \
  --name kapua-event-broker \
  -p 5672:5672  # 假设使用 AMQP 协议默认端口，具体端口需根据实际配置调整 \
  -e KAPUA_BROKER_HOST=kapua-service-host \  # Kapua 服务注册中心地址 \
  -e KAPUA_BROKER_PORT=8080 \  # Kapua 服务注册中心端口 \
  -v /path/to/local/config:/etc/kapua/event-broker/config \  # 挂载本地配置文件（可选） \
  [镜像名称]:[版本标签]  # 替换为实际镜像名称和版本（如 eclipse/kapua-event-broker:latest）

4.2 Docker Compose 配置示例

在 Kapua 多服务部署场景中，可通过 docker-compose.yml 集成 Event Broker：

yaml
version: '3.8'
services:
  kapua-event-broker:
    image: docker.xuanyuan.run/[镜像名称]:[版本标签]
    container_name: kapua-event-broker
    ports:
      - "5672:5672"  # 事件通信端口
      - "8161:8161"  # 管理控制台端口（如支持）
    environment:
      - KAPUA_BROKER_HOST=kapua-registry  # 关联 Kapua 服务注册中心
      - KAPUA_BROKER_PORT=8761
      - LOG_LEVEL=INFO  # 日志级别（DEBUG/INFO/WARN/ERROR）
    volumes:
      - ./broker-config:/etc/kapua/event-broker/config  # 挂载自定义配置
    networks:
      - kapua-network  # 加入 Kapua 服务专用网络
    restart: unless-stopped

  # 其他 Kapua 服务（如设备管理、数据处理等）可通过此网络连接 Event Broker
  kapua-device-service:
    # ... 其他服务配置 ...
    networks:
      - kapua-network

networks:
  kapua-network:
    driver: bridge

4.3 配置参数说明

由于原镜像描述未提供具体配置参数，以下为 Kapua Event Broker 常见配置项（实际使用需参考镜像内置文档或官方指南）：

注意：具体参数及默认值需以实际镜像为准，建议通过 docker inspect [镜像名称] 或查看镜像内置 README 获取详细配置说明。

五、注意事项

5.1 免责声明

本镜像对应的代码仓库不由 Eclipse Foundation 维护，使用前请确认版本兼容性及安全性，生产环境建议优先采用 Eclipse 官方维护的组件。

5.2 版本兼容性

• 需与 Kapua 平台核心版本匹配（如 Kapua v1.6.0 建议搭配对应版本的 Event Broker）
• 依赖的外部存储（如 Kafka、RabbitMQ）需满足镜像内置通信协议版本要求

5.3 部署建议

• 生产环境建议通过 Kubernetes 或 Docker Swarm 实现容器编排，确保高可用
• 配置文件建议通过外部挂载（如 docker run -v）管理，便于更新与备份
• 事件流量较大时，可通过水平扩展 Event Broker 实例并配置负载均衡提升吞吐量

六、参考信息

• 如需获取更多配置细节或官方指南，建议参考 Eclipse Kapua 官方文档：https://www.eclipse.org/kapua/
• 镜像版本及更新日志请关注对应代码仓库（非 Eclipse Foundation 维护）