Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_ENABLED

boolean

true

Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_PORT

int

Optional fixed port the dev service rest service will listen to.

If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_REST_PORT

int

Indicates if the Zeebe server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Zeebe starts a new container.

The discovery uses the quarkus-dev-service-zeebe label. The value is configured using the service-name property.

Container sharing is only used in dev mode.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_SHARED

boolean

true

The value of the quarkus-dev-service-zeebe label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for Zeebe looks for a container with the quarkus-dev-service-zeebe label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-zeebe label set to the specified value.

This property is used when you need multiple shared Zeebe servers.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_SERVICE_NAME

string

zeebe

The container image name to use, for container based DevServices providers.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_IMAGE_NAME

string

Helper to define the stop strategy for containers created by DevServices. In particular, we don’t want to actually stop the containers when they have been flagged for reuse, and when the Test-containers configuration has been explicitly set to allow container reuse. To enable reuse, ass testcontainers.reuse.enable=true in your .testcontainers.properties file, to be stored in your home.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_REUSE

boolean

false

Optional fixed debug export receiver port the dev service will listen to.

If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_TEST_RECEIVER_PORT

int

Disable or enable debug exporter for the test.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_TEST_EXPORTER

boolean

true

Enable or disable debug exporter.

Environment variable: QUARKUS_ZEEBE_DEVSERVICES_DEV_EXPORTER_ENABLED

boolean

true

Disable or enabled zeebe dashboard dev-ui.

Environment variable: QUARKUS_ZEEBE_DEV_MODE_DEV_UI_ENABLED

boolean

true

Observe changes in the bpmn files.

Environment variable: QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_FILES

boolean

true

Observe changes in the bpmn directory and subdirectories.

Environment variable: QUARKUS_ZEEBE_DEV_MODE_WATCH_BPMN_DIR

boolean

true

Observe changes in the job worker.

Environment variable: QUARKUS_ZEEBE_DEV_MODE_WATCH_JOB_WORKER

boolean

true

Whether an auto scan BPMN process folder. Default true

Environment variable: QUARKUS_ZEEBE_RESOURCES_ENABLED

boolean

true

BPMN process root folder. Default bpmn

Environment variable: QUARKUS_ZEEBE_RESOURCES_LOCATION

string

bpmn

Whether a metrics is enabled in case the micrometer or micro-profile metrics extension is present.

Environment variable: QUARKUS_ZEEBE_METRICS_ENABLED

boolean

true

Whether a health check is published in case the smallrye-health extension is present.

Environment variable: QUARKUS_ZEEBE_HEALTH_ENABLED

boolean

true

Whether an opentracing is published in case the smallrye-opentracing extension is present.

Environment variable: QUARKUS_ZEEBE_TRACING_ENABLED

boolean

true

Zeebe gateway address. Default: localhost:26500

Environment variable: QUARKUS_ZEEBE_CLIENT_BROKER_GATEWAY_ADDRESS

string

localhost:26500

Zeebe gateway rest address. Default: localhost:8080

Environment variable: QUARKUS_ZEEBE_CLIENT_BROKER_REST_ADDRESS

URI

http://0.0.0.0:8080

Client keep alive duration

Environment variable: QUARKUS_ZEEBE_CLIENT_BROKER_KEEP_ALIVE

Duration

PT45S

Cloud cluster ID

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_CLUSTER_ID

string

Cloud client secret ID

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_ID

string

Specify a client secret to request an access token.

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_CLIENT_SECRET

string

Cloud region

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_REGION

string

bru-2

Cloud base URL

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_BASE_URL

string

zeebe.camunda.io

Cloud authorization server URL

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_AUTH_URL

string

https://login.cloud.camunda.io/oauth/token

Cloud port

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_PORT

int

443

Cloud credentials cache path

Environment variable: QUARKUS_ZEEBE_CLIENT_CLOUD_CREDENTIALS_CACHE_PATH

string

OAuth client secret ID

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_ID

string

Specify a client secret to request an access token.

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_CLIENT_SECRET

string

Authorization server URL

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_AUTH_URL

string

https://login.cloud.camunda.io/oauth/token

Credentials cache path

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_CREDENTIALS_CACHE_PATH

string

OAuth connect timeout

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_CONNECT_TIMEOUT

Duration

PT5S

OAuth read timeout

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_READ_TIMEOUT

Duration

PT5S

Zeebe token audience

Environment variable: QUARKUS_ZEEBE_CLIENT_OAUTH_TOKEN_AUDIENCE

string

Maximum retries for the auto-completion command.

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_MAX_RETRIES

int

20

Maximum retries for the auto-completion command.

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_RETRY_DELAY

long

50

Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.5.

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_BACKOFF_FACTOR

double

1.5

Sets the jitter factor. The next delay is changed randomly within a range of +/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.2

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_JITTER_FACTOR

double

0.2

Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 1000ms.

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MAX_DELAY

long

1000

Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms.

Environment variable: QUARKUS_ZEEBE_CLIENT_AUTO_COMPLETE_EXP_MIN_DELAY

long

50

Client message time to live duration.

Environment variable: QUARKUS_ZEEBE_CLIENT_MESSAGE_TIME_TO_LIVE

Duration

PT1H

Client security plaintext flag.

Environment variable: QUARKUS_ZEEBE_CLIENT_SECURITY_PLAINTEXT

boolean

true

Specify a path to a certificate with which to validate gateway requests.

Environment variable: QUARKUS_ZEEBE_CLIENT_SECURITY_CERT_PATH

string

Overrides the authority used with TLS virtual hosting. Specifically, to override hostname verification in the TLS handshake. It does not change what host is actually connected to.

Environment variable: QUARKUS_ZEEBE_CLIENT_SECURITY_OVERRIDE_AUTHORITY

string

Client worker maximum active jobs.

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_MAX_JOBS_ACTIVE

int

32

Client worker number of threads

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_WORKER_EXECUTION_THREADS

int

1

Client worker default name

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_WORKER_NAME

string

default

Zeebe client request timeout configuration.

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_REQUEST_TIMEOUT

Duration

PT45S

Client worker global type

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_DEFAULT_TYPE

string

Client job timeout

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_TIMEOUT

Duration

PT5M

Client job pool interval

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_POOL_INTERVAL

Duration

PT0.100S

Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in the JobHandler should be handled there, and retried there if need be. Sets the backoff multiplication factor. The previous delay is multiplied by this factor. Default is 1.6.

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_EXP_BACKOFF_FACTOR

double

1.6

Sets the jitter factor. The next delay is changed randomly within a range of +/- this factor. For example, if the next delay is calculated to be 1s and the jitterFactor is 0.1 then the actual next delay can be somewhere between 0.9 and 1.1s. Default is 0.1

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_EXP_JITTER_FACTOR

double

0.1

Sets the maximum retry delay. Note that the jitter may push the retry delay over this maximum. Default is 5000ms.

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_EXP_MAX_DELAY

long

5000

Sets the minimum retry delay. Note that the jitter may push the retry delay below this minimum. Default is 50ms.

Environment variable: QUARKUS_ZEEBE_CLIENT_JOB_EXP_MIN_DELAY

long

50

List of span names

Environment variable: QUARKUS_ZEEBE_CLIENT_TRACING_ATTRIBUTES

list of string

Zeebe client tenant ID. The tenant identifier which is used for tenant-aware commands when no tenant identifier is set.

Environment variable: QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_TENANT_ID

string

<default>

Zeebe client default job worker tenant ID’s. The tenant identifiers which are used for job-activation commands when no tenant identifiers are set.

Environment variable: QUARKUS_ZEEBE_CLIENT_TENANT_DEFAULT_JOB_WORKER_TENANT_IDS

list of string

<default>

Zeebe client is active

Environment variable: QUARKUS_ZEEBE_ACTIVE

boolean

true

Zeebe worker enable or disable flag.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__ENABLED

boolean

Zeebe worker handler name.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__NAME

string

Zeebe worker timeout.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__TIMEOUT

long

Zeebe worker maximum jobs active.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__MAX_JOBS_ACTIVE

int

Zeebe worker request timeout.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__REQUEST_TIMEOUT

long

Zeebe worker poll interval.

Environment variable: QUARKUS_ZEEBE_CLIENT_WORKERS__WORKERS__POLL_INTERVAL

long

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.