此存储库包含 Camunda Platform 8 资源、官方发布工件(二进制文件)以及用于将 Docker Compose 作为本地开发选项运行的支持配置文件的链接。
我们建议使用 SaaS 或 Helm/Kubernetes 进行开发。
有关自我管理的更多信息,包括其他开发安装选项,请参阅我们的文档。
对于生产设置,我们建议使用 Helm 图表,可以在 helm.camunda.io 上找到该图表。
此存储库中的 docker-compose 文件使用最新的 compose 规范,该规范是在 docker compose 版本 1.27.0+ 中引入的。请确保使用最新的 docker compose 版本。
需要 Docker 20.10.16+。
为了支持令牌刷新和注销,您的本地计算机需要将
keycloak
解析为127.0.0.1
,并且需要将变量KEYCLOAK_HOST
设置为.env
文件中的keycloak
。
要在本地启动完整的 Camunda Platform 8 自管理环境,可以使用此存储库中的 docker-compose.yaml 文件。
完整的环境包含以下组件:
默认情况下不包含 Web Modeler。请按照以下说明进行安装。
克隆此存储库并发出以下命令来启动您的环境:
docker compose up -d
等待几分钟,让环境启动并稳定下来。监控日志,尤其是Keycloak容器日志,以确保组件已启动。
现在您可以导航到不同的网络应用程序并使用用户demo
和密码demo
登录:
Keycloak用于管理用户。这里可以使用用户admin
和密码admin
登录
工作流引擎 Zeebe 可在localhost:26500
使用 gRPC 来使用。
要拆除整个环境,请运行以下命令:
docker compose down -v
Zeebe、Operate、Tasklist 以及 Optimize 需要与 Identity 分开的网络,正如您将在 docker-compose 文件中看到的那样。
如果不需要 Optimize、Identity 和 Keycloak,您可以使用 docker-compose-core.yaml 代替,它不包含以下组件:
docker compose -f docker-compose-core.yaml up -d
或者
如果要使用 OpenSearch 而不是 ElasticSearch,请在.env
文件中设置参数SEARCH_DB=opensearch
docker compose -f docker-compose-core.yaml --profile opensearch up -d
除了使用 docker compose 设置本地环境之外,还可以使用 Camunda Desktop Modeler 对 BPMN 图进行本地建模以供执行,并将其直接部署到本地环境。作为企业客户,您可以使用 Web Modeler。
欢迎反馈和更新!
默认情况下,Zeebe GRPC API 可公开访问,无需任何客户端凭据即可进行开发。
但是,您可以通过将环境变量ZEEBE_AUTHENTICATION_MODE
设置为identity
来启用 Zeebe 中的 GRPC 请求身份验证,例如通过运行:
ZEEBE_AUTHENTICATION_MODE=identity docker compose up -d
或者通过修改.env
文件中的默认值。
两个 docker-compose 文件都包含我们开箱即用的连接器。
有关如何提供相关连接器模板以进行建模的详细信息,请参阅连接器安装指南。
要将机密注入连接器运行时,可以将其以每行NAME=VALUE
格式添加到存储库内的connector-secrets.txt
文件中。然后,这些机密将在连接器运行时中以secrets.NAME
格式提供。
要添加自定义连接器,请创建一个新的 docker 映像,将它们捆绑在一起,如此处所述。
或者,您可以通过将新的连接器 JAR 添加到 docker-compose 文件,将新的连接器 JAR 作为卷安装到/opt/app
文件夹中。请记住,连接器 JAR 需要将所有必需的依赖项带入 JAR 内。
提供的 docker compose 文件中提供了kibana
配置文件,以支持在 Elasticsearch 中检查和探索 Camunda Platform 8 数据。可以通过将--profile kibana
添加到 docker compose 命令来启用它。除了其他组件之外,此配置文件还启动 Kibana。 Kibana 可用于探索 Zeebe 导出到 Elasticsearch 中的记录,或发现 Elasticsearch 中其他组件(例如 Operate)使用的数据。
您可以导航到 Kibana Web 应用程序并开始探索数据,而无需登录凭据:
注意您需要先在 Kibana 中配置索引模式,然后才能探索数据。
- 转到
Management > Stack Management > Kibana > Index Patterns
。- 创建新的索引模式。例如,
zeebe-record-*
匹配导出的记录。
- 如果您没有看到任何索引,请确保首先导出一些数据(例如部署进程)。当导出该类型的第一条记录时,将创建记录的索引。
- 转至
Analytics > Discover
并选择索引模式。
Desktop Modeler 是开源的,可以免费使用。
下载 Desktop Modeler 并开始在本地计算机上对 BPMN、DMN 和 Camunda Forms 进行建模。
准备好部署或执行流程后,请使用这些设置部署到本地 Zeebe 实例:
None
http://localhost:26500
如果您在 Zeebe 上启用了 GRPC 请求身份验证,则需要在部署和执行流程时提供客户端凭据:
OAuth
http://localhost:26500
zeebe
zecret
http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token
zeebe-api
Web Modeler 自我管理仅适用于 Camunda 企业客户。
Web Modeler 的 Docker 映像可在私有注册表中获取。企业客户要么已经拥有此注册表的凭据,要么可以通过 Camunda 的 CSM 联系人请求访问此注册表。
要使用 Web Modeler 自管理运行 Camunda 平台,请克隆此存储库并发出以下命令:
$ docker login registry.camunda.cloud
Username: your_username
Password: ******
Login Succeeded
.env
文件并设置参数SEARCH_DB=elasticserach
(此默认值) $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml up -d
ElasticSearch
拆除整个环境,请运行以下命令 $ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down -v
如果您想删除所有内容(包括您创建的任何数据)。或者,如果您想保持数据运行:
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml down
要使用OpenSearch
运行 Camunda 平台,请执行以下命令
.env
文件并设置参数SEARCH_DB=opensearch
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml --profile opensearch up -d
$ docker compose -f docker-compose.yaml -f docker-compose-web-modeler.yaml --profile opensearch down -v
您可以访问 Web Modeler Self-Managed,并使用用户demo
和密码demo
登录(http://localhost:8070)。
准备好部署或执行流程后,请使用这些设置部署到本地 Zeebe 实例:
None
http://zeebe:26500
如果您在 Zeebe 上启用了 GRPC 请求身份验证,则需要在部署和执行流程时提供客户端凭据:
OAuth
http://zeebe:26500
zeebe
zecret
http://keycloak:18080/auth/realms/camunda-platform/protocol/openid-connect/token
zeebe-api
该设置包括 Mailpit 作为测试 SMTP 服务器。它捕获 Web Modeler 发送的所有电子邮件,但不会将它们转发给实际收件人。
您可以在 Mailpit 的 Web UI 中访问电子邮件:http://localhost:8075。
在此存储库上提交问题时,请确保您的问题与Camunda平台的docker compose部署方法有关。有关网络应用程序功能的所有问题都应发布在 Camunda 论坛上。这是用户查询其他人已经遇到过的现有答案的最佳方式。我们在该论坛上还有一个专门针对部署相关主题的类别。
当使用基于arm64的硬件(如M1或M2 Mac)时,Keycloak容器可能无法启动,因为Bitnami仅为版本<22提供基于amd64的映像。您可以使用以下命令在本地构建和标记基于arm的映像。构建并标记图像后,您可以启动环境,如使用 docker-compose 中所述。
$ DOCKER_BUILDKIT=0 docker build -t bitnami/keycloak:19.0.3 "https://github.com/camunda/camunda-platform.git#8.2.15:.keycloak/"
您可以使用基于资源的授权来控制对操作和任务列表中特定流程和决策表的访问。
默认情况下禁用此功能,可以通过.env
文件或通过命令行将RESOURCE_AUTHORIZATIONS_ENABLED
设置为true
来启用:
RESOURCE_AUTHORIZATIONS_ENABLED=true docker compose up -d
您可以使用多租户来实现基于租户的隔离。
默认情况下禁用此功能,可以通过.env
文件或通过命令行将MULTI_TENANCY_ENABLED
设置为true
来启用:
ZEEBE_AUTHENICATION_MODE=identity MULTI_TENANCY_ENABLED=true docker compose up -d
如上所示,该功能还要求您使用identity
作为身份验证提供者。
确保在启动平台后以身份设置租户。
正在寻找有关 Camunda Platform 7 的信息?查看以下链接: