camunda/connectors-bundle

Camunda开箱即用连接器捆绑包

1. 镜像概述和主要用途

Camunda Connectors Bundle（连接器捆绑包）是一个集成了所有Camunda开箱即用连接器的Docker镜像。它提供了一种便捷方式，可在本地环境或Kubernetes（K8s）中快速试用这些连接器。该镜像基于Dockerfile构建，包含Camunda [Connector Runtime]（连接器运行时）和所有官方提供的开箱即用连接器，启动时会将/opt/app目录下的所有JAR文件作为类路径加载。

2. 核心功能和特性

• 集成所有官方连接器：包含Camunda提供的全部开箱即用连接器，无需单独下载安装。
• 内置Connector Runtime：预集成连接器运行时环境，可直接启动并运行连接器。
• 支持自定义扩展：允许通过挂载外部JAR文件向类路径添加自定义连接器。
• 灵活的密钥管理：支持通过环境变量、Shell环境变量或环境变量文件注入密钥，满足安全配置需求。

3. 使用场景和适用范围

• 本地开发与测试：开发人员可在本地快速搭建包含完整连接器的Camunda环境，验证流程与外部系统集成。
• Kubernetes部署：可作为容器化应用部署到K8s集群，用于生产或预生产环境的流程自动化。
• 多系统集成场景：适用于需要通过Camunda流程引擎连接多种外部系统（如数据库、消息队列、云服务等）的业务场景。

4. 使用方法和配置说明

4.1 Docker容器运行

通过docker run命令直接启动连接器捆绑包容器，支持挂载自定义连接器JAR和注入密钥：

bash
docker run --rm --name=connectors -d \
           -v $PWD/connector.jar:/opt/app/ \  # 挂载自定义连接器JAR到类路径
           -e MY_SECRET=secret \              # 直接指定密钥值
           -e SECRET_FROM_SHELL \             # 从当前Shell环境继承密钥值
           --env-file secrets.txt \           # 从文件批量注入密钥
           camunda/connectors-bundle:8.3.0

参数说明：

• -v $PWD/connector.jar:/opt/app/：将本地connector.jar挂载到容器/opt/app目录，使其被添加到类路径，实现自定义连接器扩展。
• -e MY_SECRET=secret：直接在命令中指定密钥MY_SECRET的值为secret。
• -e SECRET_FROM_SHELL：仅指定密钥名称，其值会从执行docker run命令时的Shell环境变量中继承。
• --env-file secrets.txt：通过文件批量注入密钥，文件格式为每行NAME=VALUE（如DB_PASSWORD=123456）。

4.2 Docker Compose集成

Connectors Bundle已集成到Camunda官方https://github.com/camunda/camunda-distributions/tree/main/docker-compose%E4%B8%AD%EF%BC%8C%E5%8F%AF%E7%9B%B4%E6%8E%A5%E9%80%9A%E8%BF%87Camunda docker-compose发行版部署，无需单独配置。

4.3 密钥注入方式详解

4.3.1 直接指定密钥值

在docker run命令中通过-e KEY=VALUE直接定义密钥，适用于临时测试或非敏感配置：

bash
-e API_KEY=abc123  # 直接设置API_KEY的值为abc123

4.3.2 从Shell环境继承密钥

仅指定密钥名称（不加=VALUE），容器会自动继承当前Shell环境中同名变量的值：

bash
# 先在Shell中定义变量
export DB_USER=admin
# 启动容器时注入
docker run ... -e DB_USER ... camunda/connectors-bundle:8.3.0

4.3.3 通过环境变量文件注入

创建secrets.txt文件（格式为NAME=VALUE每行一个密钥），通过--env-file批量注入：

txt
# secrets.txt内容示例
AWS_ACCESS_KEY=AKIAEXAMPLE
AWS_SECRET_KEY=examplekey123

启动命令：

bash
docker run ... --env-file secrets.txt camunda/connectors-bundle:8.3.0

4.4 添加自定义连接器

通过挂载外部JAR文件扩展连接器：将自定义连接器JAR文件（如my-connector.jar）挂载到容器/opt/app目录，容器启动时会自动将其添加到类路径。示例：

bash
docker run ... -v /path/to/my-connector.jar:/opt/app/my-connector.jar ... camunda/connectors-bundle:8.3.0

详细扩展方法参见Connector Runtime文档。

5. 构建镜像

如需自定义构建连接器捆绑包镜像，执行以下命令（需替换${VERSION}为目标版本号）：

bash
docker build -t camunda/connectors-bundle:${VERSION} .

6. 注意事项

• 密钥管理：生产环境中建议优先使用--env-file或从Shell环境注入密钥，避免直接在命令中暴露敏感信息。
• 版本兼容性：确保使用的镜像版本（如8.3.0）与Camunda平台其他组件版本匹配。
• 自定义连接器：挂载的JAR文件需与Connector Runtime兼容，建议遵循Camunda连接器开发规范。