Legacy cluster configurations
DEPRECATED
This method of configuring clusters is deprecated and will be removed in a later version of Camunda Hub Self-Managed.
See the migration guide for more details.
Clusters must be configured using the following options to access the cluster from within Camunda Hub. If no clusters are configured, you will not be able to perform any actions that require a cluster (for example, deploy, start an instance, or Play a process).
The Camunda 8 Helm and Docker Compose distributions provide a local Zeebe cluster configured by default.
To add additional clusters, increment the 0 value for each entry (for example clusters[1] or CAMUNDA_MODELER_CLUSTERS_1_NAME).
Cluster version
The available configuration options depend on the version of the cluster:
Common configuration (all cluster versions)
- Environment variables
- application.yml
| Environment variable | Description | Example value |
|---|---|---|
CAMUNDA_MODELER_CLUSTERS_0_ID | A unique identifier to use for your cluster. | test-cluster-1 |
CAMUNDA_MODELER_CLUSTERS_0_NAME | The name of your cluster. | Test Cluster 1 |
CAMUNDA_MODELER_CLUSTERS_0_VERSION | The Camunda version used by this cluster. | 8.8.0 |
CAMUNDA_MODELER_CLUSTERS_0_AUTHENTICATION | The authentication to use with your cluster. | BEARER_TOKEN |
camunda.modeler.clusters:
- id: test-cluster-1
name: Test Cluster 1
version: 8.8.0
authentication: BEARER_TOKEN
Additional configuration for cluster versions >= 8.8
- Environment variables
- application.yml
| Environment variable | Description | Example value |
|---|---|---|
CAMUNDA_MODELER_CLUSTERS_0_URL_GRPC | Internal or external address where the Zeebe gRPC API can be reached. | grpc://camunda:26500,grpcs://camunda.example.com:26500 |
CAMUNDA_MODELER_CLUSTERS_0_URL_REST | Internal or external address where the cluster's REST APIs can be reached. Used as the base URL for requests to the Orchestration Cluster API. | http://camunda:8080,https://camunda.example.com |
CAMUNDA_MODELER_CLUSTERS_0_URL_WEBAPP | External address where the cluster's web applications can be reached in a browser. | https://camunda.example.com |
CAMUNDA_MODELER_CLUSTERS_0_AUTHORIZATIONS_ENABLED | Indicates if authorizations are enabled for the cluster. If true, users will see a hint when they deploy from Camunda Hub. | true |
camunda.modeler.clusters:
- # ...common configuration from above
url:
grpc: "grpc://camunda:26500" # or grpcs://camunda.example.com:26500
rest: "http://camunda:8080" # or https://camunda.example.com
webapp: "https://camunda.example.com"
authorizations:
enabled: true
Additional configuration for cluster versions < 8.8
- Environment variables
- application.yml
| Environment variable | Description | Example value |
|---|---|---|
CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_GRPC | Internal or external address where the Zeebe gRPC API can be reached. | grpc://camunda-zeebe-gateway:26500,grpcs://zeebe.example.com:26500 |
CAMUNDA_MODELER_CLUSTERS_0_URL_ZEEBE_REST | Internal or external address where the Camunda 8 REST API can be reached. | http://camunda-zeebe-gateway:8080,https://zeebe.example.com |
CAMUNDA_MODELER_CLUSTERS_0_URL_OPERATE | Internal or external address where the Operate REST API can be reached. | http://camunda-operate:80,https://operate.example.com |
CAMUNDA_MODELER_CLUSTERS_0_URL_TASKLIST | Internal or external address where the Tasklist REST API can be reached. | http://camunda-tasklist:80,https://tasklist.example.com |
camunda.modeler.clusters:
- # ...common configuration from above
url:
zeebe-grpc: "grpc://camunda-zeebe-gateway:26500"
zeebe-rest: "http://camunda-zeebe-gateway:8080"
operate: "http://camunda-operate:80"
tasklist: "http://camunda-tasklist:80"