camunda/connectors-bundle-saas

Camunda 连接器捆绑包

1. 镜像概述和主要用途

Camunda 连接器捆绑包（Connectors Bundle）是包含所有 Camunda 官方开箱即用连接器的 Docker 镜像，集成了 Connector Runtime 运行时环境。该镜像旨在提供一种便捷方式，帮助用户在本地环境或 Kubernetes 集群中快速试用、部署和扩展 Camunda 连接器，适用于 SaaS 场景及各类流程自动化需求。

2. 核心功能和特性

• 完整的连接器集合：预打包 Camunda 官方提供的所有开箱即用连接器，无需单独下载配置。
• 内置运行时环境：集成 Connector Runtime，可直接启动并加载类路径中的连接器 JAR 文件。
• 灵活扩展能力：支持通过挂载外部 JAR 文件添加自定义连接器，扩展功能。
• 多环境适配：兼容本地 Docker 部署、Kubernetes 集群及 Camunda SaaS 集成场景。
• 安全的密钥管理：支持通过环境变量、文件注入等多种方式配置敏感信息（如 API 密钥、凭证）。

3. 使用场景和适用范围

• 本地开发与测试：快速搭建 Camunda 连接器开发环境，验证流程与外部系统集成逻辑。
• Kubernetes 部署：作为微服务组件部署到 Kubernetes 集群，支持容器化流程自动化架构。
• SaaS 应用集成：与 Camunda SaaS 版本配合，快速接入各类 SaaS 服务（如邮件、云存储、API 服务等）。
• 流程自动化扩展：为 Camunda 流程引擎提供与外部系统（数据库、消息队列、第三方 API 等）的连接能力。

4. 使用方法和配置说明

4.1 Docker 运行示例

通过 docker run 命令直接启动容器，支持挂载自定义连接器、注入环境变量和密钥：

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/：将本地自定义连接器 JAR 文件挂载到容器内 /opt/app 目录（该目录下的 JAR 会自动添加到类路径）。
• -e MY_SECRET=secret：直接设置环境变量（密钥），值为 secret。
• -e SECRET_FROM_SHELL：从当前 Shell 环境继承同名变量的值（需确保执行 docker run 时 Shell 中已定义该变量）。
• --env-file secrets.txt：从指定文件注入多个密钥，文件格式为每行 NAME=VALUE（如 DB_PASSWORD=123456）。

4.2 Docker Compose 集成

该镜像已包含在 Camunda 官方 https://github.com/camunda/camunda-distributions/tree/main/docker-compose 中，可直接通过官方 Docker Compose 配置一键部署，无需单独配置。

4.3 环境变量与密钥配置

连接器运行时依赖的敏感信息（如 API 密钥、访问令牌）需通过环境变量注入，支持以下方式：

1. 直接指定值：通过 -e KEY=VALUE 在 docker run 命令中显式定义。
2. 继承 Shell 环境：通过 -e KEY 注入当前 Shell 环境中已存在的 KEY 变量值。
3. 文件批量注入：通过 --env-file filename 从文件加载多个 KEY=VALUE 格式的变量。

密钥文件示例（secrets.txt）：

AWS_ACCESS_KEY=AKIAEXAMPLE
SMTP_PASSWORD=smtp_secret_123

4.4 添加自定义连接器

如需扩展非官方连接器，可将自定义连接器 JAR 文件挂载到容器的 /opt/app 目录，运行时会自动扫描并加载该目录下的所有 JAR：

bash
# 将本地 custom-connector.jar 挂载到类路径
docker run -v $PWD/custom-connector.jar:/opt/app/custom-connector.jar camunda/connectors-bundle:8.3.0

5. 构建镜像

如需本地构建镜像，执行以下命令（需替换 ${VERSION} 为实际版本号）：

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

6. 参考链接

• Camunda 开箱即用连接器概述
• Connector Runtime 文档
• https://github.com/camunda/camunda-distributions/tree/main/docker-compose