このリポジトリには、Camunda Platform 8 リソース、公式リリース アーティファクト (バイナリ)、およびローカル開発オプションとして Docker Compose を実行するためのサポート構成ファイルへのリンクが含まれています。
開発には SaaS または Helm/Kubernetes を使用することをお勧めします。
追加の開発インストール オプションを含む自己管理の詳細については、ドキュメントを参照してください。
運用環境のセットアップでは、helm.camunda.io にある Helm チャートを使用することをお勧めします。
このリポジトリの docker-compose ファイルは、docker compose バージョン 1.27.0 以降で導入された最新の compose 仕様を使用します。必ず最新の docker compose バージョンを使用してください。
Docker 20.10.16 以降が必要です。
トークンのリフレッシュとログアウトをサポートするには、ローカル マシンで
keycloak
127.0.0.1
に解決する必要があり、.env
ファイル内で変数KEYCLOAK_HOST
keycloak
に設定する必要があります。
完全な Camunda Platform 8 セルフマネージド環境をローカルで起動するには、このリポジトリ内の docker-compose.yaml ファイルを使用できます。
完全な環境には次のコンポーネントが含まれています。
Web Modeler はデフォルトでは含まれていません。以下の手順に従ってインストールしてください。
このリポジトリのクローンを作成し、次のコマンドを発行して環境を開始します。
docker compose up -d
環境が起動して落ち着くまで、数分間待ちます。ログ、特にKeycloakコンテナのログを監視して、コンポーネントが起動していることを確認します。
これで、さまざまな Web アプリに移動し、ユーザーdemo
とパスワードdemo
を使用してログインできるようになります。
Keycloakはユーザーの管理に使用されます。ここでは、ユーザーadmin
とパスワードadmin
でログインできます
ワークフロー エンジン Zeebe はlocalhost:26500
で gRPC を使用して利用できます。
環境全体を破棄するには、次のコマンドを実行します。
docker compose down -v
docker-compose ファイルでわかるように、Zeebe、Operate、Tasklist、および Optimize には、Identity とは別のネットワークが必要です。
Optimize、Identity、Keycloak が必要ない場合は、代わりに次のコンポーネントが含まれていない docker-compose-core.yaml を使用できます。
docker compose -f docker-compose-core.yaml up -d
または
ElasticSearch の代わりに OpenSearch を使用する場合は、ファイル.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 ファイルにも、すぐに使用できるコネクタが含まれています。
モデリング用に関連するコネクタ テンプレートを提供する方法の詳細については、コネクタ インストール ガイドを参照してください。
シークレットをコネクタ ランタイムに挿入するには、リポジトリ内のconnector-secrets.txt
ファイルに 1 行あたりNAME=VALUE
形式でシークレットを追加します。その後、シークレットはコネクタ ランタイムでsecrets.NAME
の形式で使用できるようになります。
カスタム コネクタを追加するには、ここで説明されているように、それらをバンドルする新しい Docker イメージを作成します。
あるいは、これを docker-compose ファイルに追加することで、新しいコネクタ JAR をボリュームとして/opt/app
フォルダーにマウントできます。コネクタ JAR は、必要な依存関係をすべて JAR 内に組み込む必要があることに注意してください。
kibana
プロファイルは、Elasticsearch での Camunda Platform 8 データの検査と探索をサポートするために、提供された docker compose ファイルで利用できます。 --profile kibana
docker compose コマンドに追加することで有効にできます。他のコンポーネントに加えて、このプロファイルは Kibana を起動します。 Kibana を使用すると、Zeebe によって Elasticsearch にエクスポートされたレコードを探索したり、他のコンポーネント (Operate など) によって使用される Elasticsearch 内のデータを検出したりできます。
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 Self-Managed は、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
http://localhost:8070 で、Web Modeler Self-Managed にアクセスし、ユーザーdemo
とパスワードdemo
を使用してログインできます。
プロセスをデプロイまたは実行する準備ができたら、次の設定を使用してローカル 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
セットアップには、テスト SMTP サーバーとして Mailpit が含まれています。 Web Modeler によって送信されたすべての電子メールをキャプチャしますが、実際の受信者には転送しません。
http://localhost:8075 にある Mailpit の Web UI で電子メールにアクセスできます。
このリポジトリで問題を送信するときは、問題が Camunda プラットフォームの docker compose デプロイ方法に関連していることを確認してください。 Web アプリケーションの機能に関するすべての質問は、代わりに Camunda フォーラムに投稿してください。これは、ユーザーが他の人がすでに見つけた既存の回答をクエリするための最良の方法です。このフォーラムには、展開関連トピックに特化したカテゴリもあります。
M1 または M2 Mac などの arm64 ベースのハードウェアを使用する場合、Bitnami はバージョン 22 未満の amd64 ベースのイメージのみを提供するため、Keycloak コンテナーが起動しない可能性があります。次のコマンドを使用して、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/"
リソースベースの承認を使用して、Operate および Tasklist の特定のプロセスおよびデシジョン テーブルへのアクセスを制御できます。
この機能はデフォルトでは無効になっていますが、 .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
を使用することも必要です。
プラットフォームを起動した後、ID でテナントをセットアップしていることを確認してください。
Camunda Platform 7 に関する情報をお探しですか?以下のリンクをチェックしてください。