Darkモード切替

Camunda Platform のモダンなプロセスオーケストレーター Zeebe による開発環境を構築する

| 14 min read
Author: masahiro-kondo masahiro-kondoの画像

先日の、Tauri のアプリケーション開発の記事で BPMN モデリングのライブラリ bpmn.js を取り上げましたが、これは、Camunda というプロセスオーケストレーター製品を提供している会社の OSS でした。本記事では、Camunda のプロセスオーケストレーターのエンジンである Zeebe の概要と、ローカルの開発環境構築について記述します。

Contents

Camunda プロセスオーケストレーター(Zeebe) 概要#

The Universal Process Orchestrator | Camunda

Camunda Platform は、Zeebe という BPMN 2.0 に対応したプロセスオーケストレーター(ワークフローエンジン)によって構築されています。

Zeebe は Java で書かれており、リモートのワーカーと gRPC で通信して一連のプロセスを処理します。Zeebe のクラスターは Kubernetes クラスター上にデプロイ可能で、高いスケーラビリティとスループットを実現しています。

Zeebe | Camunda Platform 8

GitHub - camunda/zeebe: Distributed Workflow Engine for Microservices Orchestration

Camunda Platform では、Web 版とデスクトップ版の BPMN Modeler が提供されており、作成した BPMN モデルをデプロイして実行できます。

Camunda Modeler - Design Business Processes and Decision Models

SaaS として提供されている Camunda Platform では、さまざまな Connector を利用して、REST API やクラウドサービス、データレイクなどとの連携が可能となっています。

Connectors & Integration Framework | Camunda

アーキテクチャドキュメントの図を引用します。

Architecture | Camunda Platform 8

Zeebe クラスターは、複数の Broker と Gateway で構成されます。プロセスのタスクを実行するワーカーは Java や Go で記述可能で、gRPC で Zeebe-Gateway を通して Zeebe クラスター上のプロセスと通信します。

BPMN 2.0 対応を謳うだけあって、プロセスインスタンスを監視するダッシュボードも BPMN を表示するグラフィカルな UI になっています。

Operate - Camunda

Minikube での Camunda Plarform のデプロイ#

今回は SaaS 環境ではなく、ローカルの Minikube に Camunda の Helm chart を使って構築します。Zeebe だけでなく、Keycloak や Elasticsearch など多くのオブジェクトがデプロイされるため、メモリや CPU を多めに指定しないと Pod が起動しません。今回はメモリ8GB、CPU 4で構築しました。

minikube start --memory='8g' --cpus=4

Camunda Helm chart でデプロイされる構成図もドキュメントから引用します。

Camunda Helm charts | Camunda Platform 8

Helm chart の README に従って設定します。

camunda-platform-helm/charts/camunda-platform at main · camunda/camunda-platform-helm

以下のような YAML ファイルを values.yaml として作成しました。Zeebe、Zeebe-Gateway などの replicas を1にした上で、リソース要求を Helm chart のデフォルト設定よりかなり少なくしています。

zeebe:
clusterSize: "1"
partitionCount: "1"
replicationFactor: "1"
resources:
requests:
cpu: 200m
memory: 600Mi

zeebe-gateway:
replicas: 1
resources:
requests:
cpu: 100m
memory: 256Mi

tasklist:
resources:
requests:
cpu: 100m
memory: 256Mi

optimize:
resources:
requests:
cpu: 100m
memory: 256Mi

elasticsearch:
replicas: 1
resources:
requests:
cpu: 200m
memory: 256Mi

camunda という namespace を作成し、上記の values.yaml を指定してインストールします。

helm repo add camunda https://helm.camunda.io
helm repo update
kubectl create ns camunda
helm install camunda-pf camunda/camunda-platform -n camunda -f values.yaml

以下のように出力されます。

NAME: camunda-pf
LAST DEPLOYED: Sat Jul 16 09:49:36 2022
NAMESPACE: camunda
STATUS: deployed
REVISION: 1
NOTES:
# (camunda-platform - 8.0.11)
   ___   _   __  __ _   _ _  _ ___   _     ___ _      _ _____ ___ ___  ___ __  __ 
  / __| /_\ |  \/  | | | | \| |   \ /_\   | _ \ |    /_\_   _| __/ _ \| _ \  \/  |
 | (__ / _ \| |\/| | |_| | .` | |) / _ \  |  _/ |__ / _ \| | | _| (_) |   / |\/| |
  \___/_/ \_\_|  |_|\___/|_|\_|___/_/ \_\ |_| |____/_/ \_\_| |_| \___/|_|_\_|  |_|
                                                                                 

## Installed Services:

- Zeebe:
  - Enabled: true
  - Docker Image used for Zeebe: camunda/zeebe:8.0.0
  - Zeebe Cluster Name: "camunda-pf-zeebe"
  - Prometheus ServiceMonitor Enabled: false
- Operate:
  - Enabled: true
  - Docker Image used for Operate: camunda/operate:8.0.0
- Tasklist:
  - Enabled: true
  - Docker Image used for Tasklist: camunda/tasklist:8.0.0
- Optimize:
  - Enabled: true
  - Docker Image used for Optimize: camunda/optimize:3.8.0
- Identity:
  - Enabled: true
  - Docker Image used for Identity: camunda/identity:8.0.0
  - Keycloak: bitnami/keycloak:16.1.1-debian-10-r52
- Elasticsearch:
  - Enabled: true
  - ElasticSearch URL: http://elasticsearch-master:9200

### Zeebe

The Cluster itself is not exposed as a service that means that you can use `kubectl port-forward` to access the Zeebe cluster from outside Kubernetes:

> kubectl port-forward svc/camunda-pf-zeebe-gateway 26500:26500 -n camunda

Now you can connect your workers and clients to `localhost:26500`

### Connecting to Web apps

As part of the Helm charts an ingress definition can be deployed, but you require to have an Ingress Controller for that Ingress to be Exposed.
In order to deploy the ingress manifest, set `<service>.ingress.enabled` to `true`. Example: `operate.ingress.enabled=true`

If you don't have an ingress controller you can use `kubectl port-forward` to access the deployed web application from outside the cluster:

Identity: kubectl port-forward svc/camunda-pf-identity 8080:80
Operate:  kubectl port-forward svc/camunda-pf-operate  8081:80
Tasklist: kubectl port-forward svc/camunda-pf-tasklist 8082:80
Optimize: kubectl port-forward svc/camunda-pf-optimize 8083:80

If you want to use different ports for the services, please adjust the related configs in the values file since these ports are used as redirect URL for Keycloak.

The authentication via Identity/Keycloak is enabled. In order to login into one of the services please port-forward to Keycloak
as well, otherwise a login will not be possible. Make sure you use `18080` as port.

> kubectl port-forward svc/camunda-pf-keycloak 18080:80

Now you can point your browser to one of the service's login page. Example: http://localhost:8081 for Operate.

Default user and password: "demo/demo"

PostgreSQL や Keycloak、Elasticsearch の Pod が正常に起動するまで10分ぐらい時間がかかりますが、無事起動しました。

kubectl get po -n camunda
NAME                                        READY   STATUS    RESTARTS        AGE
camunda-pf-identity-647f589df-njzgg         1/1     Running   5 (2m41s ago)   10m
camunda-pf-keycloak-0                       1/1     Running   0               10m
camunda-pf-operate-64bd9d4c4-zp7w2          1/1     Running   1 (5m20s ago)   10m
camunda-pf-optimize-9f4cbfb86-kpng9         1/1     Running   0               10m
camunda-pf-postgresql-0                     1/1     Running   0               10m
camunda-pf-tasklist-98844898c-qj6wg         1/1     Running   1 (5m48s ago)   10m
camunda-pf-zeebe-0                          1/1     Running   0               10m
camunda-pf-zeebe-gateway-64d9878ff6-bck4x   1/1     Running   0               10m
elasticsearch-master-0                      1/1     Running   0               10m

管理画面用の Identify / Operate / Tasklist / Optimize などの Pod も起動されています。

Camunda の Service を port-forward して、ブラウザから localhost で使えるようにします。

Identify 画面用。

kubectl port-forward svc/camunda-pf-identity 8080:80 -n camunda

Operate 画面用。

kubectl port-forward svc/camunda-pf-operate  8081:80 -n camunda

Tasklist 画面用。

kubectl port-forward svc/camunda-pf-tasklist 8082:80 -n camunda

Optimize 画面用。

kubectl port-forward svc/camunda-pf-optimize 8083:80 -n camunda

Keycloak 用。

kubectl port-forward svc/camunda-pf-keycloak 18080:80 -n camunda

さらに、client から Zeebe クラスターに接続するための Zeebe-Gateway 用。

kubectl port-forward svc/camunda-pf-zeebe-gateway 26500:26500 -n camunda

以上、6つの port-forward 用ターミナルが必要となります。

Client 認証設定#

Helm chart でインストールした環境には、demo ユーザーがあらかじめ登録されています(パスワードも demo)。この状態でも Web 画面にログインして操作したり、Camunda Modeler からモデルを登録したりすることは可能ですが、今回は CLI client を使って、BPMN の登録や実行、ワーカーの登録などを行いたいので、Keycloak で client 認証を有効化します。

Keycloak の管理者(admin)のパスワードは、以下のコマンドで namespace に登録された secret から取得できます。

kubectl -n camunda get secret camunda-pf-keycloak -o jsonpath="{.data.admin-password}" | base64 --decode

Keycloak の URL (http://localhost:18080) で上記のパスワードを使用して admin としてログインします。Relm camunda-platform に account という Client ID が登録されており、これに Camunda Platform を使用する権限が付与されています。

インストール直後はこの client は無効になっているため、Edit ボタンをクリックして編集画面で有効にした上で以下も設定します。

  • Access Typeconfidential
  • Direct Access Grants Enabled を ON
  • Service Accounts Enabled を ON

以上で、Keycloak の設定は完了です。

CLI client のインストールと設定#

CLI client が提供されており、プロセスのデプロイや起動、ワーカーの登録ができます。簡単なワーカーの実装もライブラリを使ってコードを書かなくてもできます。

CLI client | Camunda Platform 8

zbctl という NPM パッケージになっていて、グローバルインストールして使用します。

npm i -g zbctl

zbctl を実行するのに、Minikube から port-forward しているポートや、Client ID、Client Secret を環境変数に登録します[1]

# Zeebe-Gateway のアドレス
export ZEEBE_ADDRESS='127.0.0.1:26500'
# Keycloak の Client ID
export ZEEBE_CLIENT_ID='account'
# Keycloak の account の Credentials タブで取得できる Secret
export ZEEBE_CLIENT_SECRET='MSDxVqT8x1TibgiPC6TtCEDVesiNL7V1'
# OIDC トークンを取得するエンドポイント (Keycloak の camunda-platform relm のものを指定)
export ZEEBE_AUTHORIZATION_SERVER_URL='http://localhost:18080/auth/realms/camunda-platform/protocol/openid-connect/token/'

zbctl で Zeebe クラスターの状態を取得します。TLS 設定をしていないため、--insecure オプションを指定しています。

zbctl status --insecure

うまくいけば、credentials の警告は出るものの、Zeebe クラスターの情報が出力されます。

2022/07/17 12:04:59 Warning: The configured security level does not guarantee that the credentials will be confidential. If this unintentional, please enable transport security.

Cluster size: 1
Partitions count: 1
Replication factor: 1
Gateway version: 8.0.0
Brokers:
  Broker 0 - camunda-pf-zeebe-0.camunda-pf-zeebe.camunda.svc:26501
    Version: 8.0.0
    Partition 1 : Leader, Healthy

Camunda Modeler による BPMN 定義とデプロイ・実行#

BPMN 定義の編集・デプロイ・実行ができる Modeler をダウンロードしてインストールします。

Download Camunda Modeler: Automate business processes and decisions

まず 簡単な BPMN 定義を作りました。アクティビティは、歯車のついた Service Task にして、Task definition の Type に文字列を入れる必要があります。

定義を作ってエラーが出なくなったら、ステータスバーの 🚀 をクリックして、Deploy します。Cluster endpoint は Zeebe-Gateway のホスト名とポートを指定します。

Deploy が成功すると以下のようにバナーが出ます。

▶ をクリックするとプロセスのインスタンスを起動できます。

起動が成功すると以下のようにバナーが出ます。

Operate 画面で確認します。Operate 画面の URL (http://localhost:8081) に接続すると keycloak の認証画面にリダイレクトされますので、demo/demo でログインします。

Operate 画面の Dashboard が表示されます。Modeler からデプロイして起動したプロセスが起動しているので、緑のバーをクリックします。

起動中のプロセスの詳細が見えます。2つあるアクティビティの1つ目で待機状態になっています。

以上のように、Modeler で作成したモデルをデプロイしてプロセスとして起動し、状態を監視できます。

CLI client でワーカー登録、プロセスのデプロイ、実行#

次に、CLI client を使って、以下を実施します。

  • モデルファイルのデプロイ
  • モデル内のアクティビティのタスクを実行するワーカーの作成と登録
  • プロセスの実行

以下のドキュメントにある Getting started の手順です。

CLI client - Getting started guide | Camunda Platform 8

ドキュメントにリンクされている gettingstarted_quickstart_advanced.bpmn ファイルを使います。Ping という Service task の Task definition で type test-worker が指定されており、この名前のワーカーを登録することで、Ping アクティビティの処理を実行し、完了させることができます。後続の Return コンディションで、結果により分岐するフローになっています。

Information

gettingstarted_quickstart_advanced.bpmn ファイルの定義にはタイポがあって、デプロイエラーになりました。モデル上の Condition の名前が Return なのに、分岐条件の式が =return="Pong" のように先頭が小文字になっていたためのパースエラーでした。以下のスクリーンショットは修正したものです。

今回は、CLI client でデプロイを実行します。

zbctl deploy --insecure resource gettingstarted_quickstart_advanced.bpmn

成功すると以下のような JSON が返却されます。

{
  "key":  "2251799813685261",
  "deployments":  [
    {
      "process":  {
        "bpmnProcessId":  "camunda-cloud-quick-start-advanced",
        "version":  1,
        "processDefinitionKey":  "2251799813685260",
        "resourceName":  "gettingstarted_quickstart_advanced.bpmn"
      }
    }
  ]
}

次に、Ping アクティビティ用のワーカー test-worker を作ります。CLI client では、ワーカー名とハンドラーを指定してワーカーを登録できます。ここでは、ReturnPong という値を設定した JSON を出力するシェルを書いています。

zbctl create --insecure worker test-worker --handler "echo {\"Return\":\"Pong\"}"

ワーカーは、待ち受け状態になります。次に、デプロイしたプロセスを起動します。

zbctl create --insecure instance camunda-cloud-quick-start-advanced

プロセス起動後しばらくすると test-worker のターミナルに、gRPC 通信のログが出力されます。

2022/07/17 13:25:53 Activated job 2251799813685295 with variables {}

2022/07/17 13:25:53 Handler completed job 2251799813685295 with variables {"Return":"Pong"}

Operate 画面で実行結果を確認すると、ワーカーの実行結果が "Pong" であったため、上側の分岐を辿ったことがわかります。

次に、同じ名前でもう一つワーカーを登録します。"Pong" ではなく "..." を Return に設定するワーカーです。

zbctl create --insecure worker test-worker --handler "echo {\"Return\":\"...\"}"

そして、1秒間隔でプロセスを起動するシェルを実行し、適当なところで Ctrl + C で停止します。

while true; do zbctl create --insecure instance camunda-cloud-quick-start-advanced; sleep 1; done

Operate 画面で、立て続けに実行され完了したプロセスのリストが見えます。

実行されたタイミングでは、{"Return":"..."} を出力するワーカーにタスクが割り当てられ、下側の分岐を辿るプロセスもあります。

このようにワーカーを冗長構成で配置して、多数のプロセスを捌くことができます。

今回は CLI client を使用しましたが、Camunda 公式では、Java と Go の client ライブラリが提供されており、Community ベースで JavaScript / Python / Rust など様々な言語の Client ライブラリが開発されています。

Overview | Camunda Platform 8

まとめ#

以上、Camunda のローカル環境を構築しました。Camunda の SaaS にサインアップすると、このような面倒な構築作業をスキップしてモデリングしたプロセスをデプロイ・実行できます。Modeler も Web 版が提供されているため、ローカルにインストールする必要はありません。

公式ドキュメントには、ローカルで構築した環境に対して zbctl を実行するための手順が書かれていないので、Keycloak の設定を覗いて少し試行錯誤が必要でした。認証さえ通ってしまえば快適に操作できます。

Camunda Platform には、DMN という意思決定エンジンもあり、これもグラフィカルなエディタで定義してデプロイできます。

Create decision tables using DMN | Camunda Platform 8

また、ワーカーが自動で実行するタスクではなく人が介在する Human Task もサポートされています。

Getting started with Human Task Orchestration | Camunda Platform 8

この手の製品は古くからあまたありましたが、Camunda はモダンなアーキテクチャとなっており、BPMN モデルがそのままプロセスとして動くということで、使いやすい印象を受けました。

BPM やマイクロサービスのオーケストレーターとして、有力な選択肢になりそうです。


  1. 起動パラメータとしても渡せます ↩︎