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_HUB_CLUSTERS_1_NAME).

Cluster version

The available configuration options depend on the version of the cluster:

• Common configuration (all cluster versions)
• Additional configuration for cluster versions >= 8.8

Common configuration (all cluster versions)

Environment variables

Environment variable	Description	Example value
CAMUNDA_HUB_CLUSTERS_0_ID	A unique identifier to use for your cluster.	test-cluster-1
CAMUNDA_HUB_CLUSTERS_0_NAME	The name of your cluster.	Test Cluster 1
CAMUNDA_HUB_CLUSTERS_0_VERSION	The Camunda version used by this cluster.	8.8.0
CAMUNDA_HUB_CLUSTERS_0_AUTHENTICATION	The authentication to use with your cluster.	BEARER_TOKEN

application.yml

camunda.hub.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

Environment variable	Description	Example value
CAMUNDA_HUB_CLUSTERS_0_URL_GRPC	Internal or external address where the Zeebe gRPC API can be reached. Optional. If you omit it, Camunda Hub uses the REST API for deployments, instance starts, and job workers, and job streaming is disabled.	grpc://camunda:26500, grpcs://camunda.example.com:26500
CAMUNDA_HUB_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. Required.	http://camunda:8080, https://camunda.example.com
CAMUNDA_HUB_CLUSTERS_0_URL_WEBAPP	External address where the cluster's web applications can be reached in a browser.	https://camunda.example.com
CAMUNDA_HUB_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

application.yml

camunda.hub.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

Cluster communication protocol

The REST URL is required for clusters version 8.8 and later. The gRPC URL is optional.

• If you configure both URLs, Camunda Hub uses gRPC to interact with the cluster. To use REST instead, set camunda.client.gateway.preferRestOverGrpc=true (environment variable CAMUNDA_CLIENT_GATEWAY_PREFERRESTOVERGRPC).
• If you configure only the REST URL, Camunda Hub uses REST to interact with the cluster. Job streaming is disabled because it is only available over gRPC. Use this setup if the network between Camunda Hub and the cluster only allows HTTP(S) traffic, for example when port 26500 is blocked.
• If you configure only the gRPC URL, or neither URL, startup validation fails.