camunda/connectors

Camunda 8 Connector Runtime Docker镜像文档

1. 镜像概述和主要用途

本项目提供一个基础Docker镜像，包含https://github.com/camunda-community-hub/spring-zeebe/tree/master/connector-runtime。该镜像启动Connector Runtime时，会将/opt/app目录中所有jar文件作为类路径加载。

使用此镜像时，需至少添加一个连接器到类路径中。建议提供包含所有依赖的捆绑JAR文件。

2. 核心功能和特性

• 类路径自动加载：启动时自动将/opt/app目录下的所有JAR文件纳入类路径，无需手动配置
• 环境变量注入：支持通过容器环境变量注入secrets，供连接器运行时使用
• 依赖冲突提示：所有连接器共享单一类路径，不同版本的相同依赖可能导致冲突。建议在连接器JAR中对公共依赖（如jackson）进行shade和重定位处理以避免冲突

3. 使用场景和适用范围

适用于Camunda 8工作流环境中，需要集成外部系统（如HTTP服务、数据库、消息队列等）的场景。通过加载不同连接器JAR，可实现工作流与外部系统的双向数据交互，满足各类业务集成需求。

4. 使用方法和配置说明

4.1 添加连接器JAR文件

需将连接器JAR文件添加到/opt/app目录以纳入类路径，支持以下两种方式：

4.1.1 通过扩展镜像添加JAR

创建Dockerfile扩展基础镜像，直接添加连接器JAR：

dockerfile
FROM docker.xuanyuan.run/camunda/connectors:0.21.0

# 添加HTTP-JSON连接器（示例）
ADD https://repo1.maven.org/maven2/io/camunda/connector/connector-http-json/0.11.0/connector-http-json-0.21.0-with-dependencies.jar /opt/app/

4.1.2 通过卷挂载添加JAR

使用-v参数将本地JAR文件挂载到容器/opt/app目录：

bash
docker run --rm --name=connectors -d \
  -v $PWD/connector.jar:/opt/app/ \
  docker.xuanyuan.run/camunda/connectors:0.21.0

4.2 注入Secrets

连接器运行时需通过容器环境变量注入secrets，支持以下注入方式：

4.2.1 直接指定环境变量值

通过-e参数在docker run命令中直接设置secrets值：

bash
docker run --rm --name=connectors -d \
  -v $PWD/connector.jar:/opt/app/ \
  -e MY_SECRET=secret_value \  # 直接指定secrets值
  camunda/connectors:0.21.0

4.2.2 从当前Shell环境注入

通过-e参数引用当前Shell环境中已存在的变量：

bash
# 先在Shell中定义变量
export SECRET_FROM_SHELL=shell_secret_value

# 注入该变量到容器
docker run --rm --name=connectors -d \
  -v $PWD/connector.jar:/opt/app/ \
  -e SECRET_FROM_SHELL \  # 引用Shell环境变量
  camunda/connectors:0.21.0

4.2.3 通过环境变量文件注入

使用--env-file参数加载包含多个NAME=VALUE格式的文件：

bash
# secrets.txt文件内容示例：
# DB_PASSWORD=db_secret
# API_KEY=api_key_value

docker run --rm --name=connectors -d \
  -v $PWD/connector.jar:/opt/app/ \
  --env-file secrets.txt \  # 从文件加载多个secrets
  camunda/connectors:0.21.0

4.3 Docker Compose配置示例

创建docker-compose.yml管理容器部署：

yaml
version: '3.8'
services:
  connectors:
    image: docker.xuanyuan.run/camunda/connectors:0.21.0
    container_name: camunda-connectors
    volumes:
      - ./connector.jar:/opt/app/  # 挂载连接器JAR
    environment:
      - MY_SECRET=secret_value     # 直接设置环境变量
      - SECRET_FROM_SHELL          # 引用宿主机环境变量
    env_file:
      - ./secrets.txt              # 从文件加载secrets

5. 连接器捆绑包

https://github.com/camunda/connectors-bundle包含Camunda 8提供的所有开箱即用连接器，可直接用于本运行时环境。

6. 源码地址

https://github.com/camunda/connector-runtime-docker