Extension Configuration Reference

Classpath resource path where workflow definition files are located.

Workflow files must be placed in src/main/resources/{path} to be available at runtime. Maven automatically copies files from src/main/resources to the classpath.

Default: flow (expects files in src/main/resources/flow)

Example: Setting workflows expects workflow files in src/main/resources/workflows.

Test workflows in src/test/resources/{path} override main workflows with the same relative path when running tests.

Environment variable: QUARKUS_FLOW_DEFINITIONS_DIR

Naming strategy to be used when generating Identifier#value() for io.quarkiverse.flow.Flow and io.serverlessworkflow.impl.WorkflowDefinition beans generated from YAML/JSON DSL.

Given a workflow definition with namespace (namespace: foo) name (name: bar):

Environment variable: QUARKUS_FLOW_DEFINITIONS_NAMING_STRATEGY

Prefix used to construct the Identifier#value() when generating io.quarkiverse.flow.Flow and io.serverlessworkflow.impl.WorkflowDefinition beans.

Must be a valid Java package name.

Example:

Generated identifiers are:

If quarkus.flow.definitions.namespace.prefix is not set, the namespace declared inside the workflow definition file is used.

Following the previous example, the generated identifiers would be:

@Identifier("flow.MyWorkflow") and @Identifier("flow:myWorkflow").

Environment variable: QUARKUS_FLOW_DEFINITIONS_NAMESPACE_PREFIX

Enables or disables backend persistence for Dev UI workflow data.

When disabled, no storage is used and no workflow metadata is persisted (DevUI only).

Environment variable: QUARKUS_FLOW_DEVUI_BACKEND_STORAGE_ENABLED

The type of storage to use for workflow instances in dev mode.

Environment variable: QUARKUS_FLOW_DEVUI_STORAGE_TYPE

Connect timeout in milliseconds.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_CONNECT_TIMEOUT

Read timeout in milliseconds.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_READ_TIMEOUT

Maximum size of the HTTP connection pool (number of concurrent connections).

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_CONNECTION_POOL_SIZE

Whether HTTP keep-alive is enabled.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_KEEP_ALIVE_ENABLED

Connection time-to-live in seconds.

After this time, idle connections can be closed and reestablished.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_CONNECTION_TTL

Quarkus REST client name used when the underlying HTTP client is shared.

This name corresponds to the Vert.x HTTP client name and is only used when shared() is true.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAME

Whether this HTTP client is shared with other Quarkus REST clients.

When true, the underlying Vert.x HttpClient can be reused across multiple REST clients based on the name().

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_SHARED

Maximum number of redirects allowed for a request.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_MAX_REDIRECTS

Maximum size of all HTTP headers for HTTP/1.x, in bytes.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_MAX_HEADER_SIZE

Maximum length of the initial HTTP/1.x request line, in bytes.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_MAX_INITIAL_LINE_LENGTH

HTTP User-Agent header to use for requests.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_USER_AGENT

Enables HTTP/2 for this client when set to true.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_HTTP2

Enables ALPN (Application-Layer Protocol Negotiation) for this client when set to true.

ALPN is typically required for HTTP/2 over TLS.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_ALPN

Whether to capture the stack trace of REST client invocations.

This is mainly useful for debugging and error reporting, at the cost of some overhead.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_CAPTURE_STACKTRACE

Logging scope for the underlying REST client.

Supported values (case-insensitive):

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_LOGGING_SCOPE

Maximum number of characters of the request/response body to log.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_LOGGING_BODY_LIMIT

Static HTTP headers to apply to every request by this client.

The value is parsed as a comma-separated list of name=value pairs, for example:

For a named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_STATIC_HEADERS

The name of the proxy configuration to use for configuring HTTP proxy.

Default client:

Named client:

There are some rules for using proxy configuration:

Use the value none to disable using the default configuration defined via quarkus.proxy.*.

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_PROXY_CONFIGURATION_NAME

Whether the client should automatically follow HTTP redirects.

When true, 3xx responses are transparently followed up to max-redirects().

Default client:

Named client:

Internally mapped to ClientBuilderImpl.followRedirects(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_FOLLOW_REDIRECTS

Whether HTTP compression is enabled.

When true, the client advertises support for compressed responses and transparently decompresses them when supported by the server.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.enableCompression(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_ENABLE_COMPRESSION

Maximum HTTP chunk size in bytes.

This controls the underlying Vert.x HTTP parser chunk size. For most users the default is sufficient; only adjust if you need fine-grained control over streaming behaviour.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.maxChunkSize(int).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_MAX_CHUNK_SIZE

Maximum content length (in bytes) for HTTP/2 clear-text upgrade (h2c).

Controls the threshold used when upgrading HTTP/1.1 connections to HTTP/2 without TLS.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.http2UpgradeMaxContentLength(int).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_HTTP2_UPGRADE_MAX_CONTENT_LENGTH

How multiple query parameters with the same name are encoded.

Valid values correspond to org.jboss.resteasy.reactive.common.jaxrs.MultiQueryParamMode: for example COMMA, DUPLICATE, ARRAY.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.multiQueryParamMode(MultiQueryParamMode).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_MULTI_QUERY_PARAM_MODE

Whether to trust all TLS certificates.

Warning: enabling this effectively disables certificate validation and should only be used in development or controlled environments.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.trustAll(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_TRUST_ALL

Whether to verify the remote TLS hostname.

When false, hostname verification is disabled. This is insecure and should only be used in development or with great care in production.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.verifyHost(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_VERIFY_HOST

Identifier of the TypeGuard<CompletionStage<WorkflowModel>> implementation to be used by this HTTP client.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_IDENTIFIER

Defines the maximum number of retries for a task execution.

The value must be greater than or equal to -1.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_RETRY_MAX_RETRIES

Enables or disables Fault Tolerance retry support.

When enabled, failed task executions may be retried according to the configured retry policy.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_RETRY_ENABLED

Defines the delay between retry attempts.

The delay is applied only after a failed execution and before a retry attempt is performed.

The initial execution is not delayed. The delay applies only to subsequent retry attempts.

A value of 0 disables the delay, causing retries to be executed immediately.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_RETRY_DELAY

Defines the jitter bound applied to the delay between retry attempts.

A random value in the range from -jitter to +jitter is added to the configured retry delay. This helps to avoid retry bursts when multiple tasks fail simultaneously.

The jitter is applied only to retry attempts. The initial execution is not affected.

A value of 0 disables jitter, causing the retry delay to be applied without any random variation.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_RETRY_JITTER

Defines the exception types that trigger a retry.

When the execution throws an exception whose type matches one of the configured values, the retry mechanism is applied.

The comparison is based on the fully qualified class name of the exception. Subclasses are also considered a match.

Default client configuration:

Named client configuration:

Example:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_RETRY_EXCEPTIONS

Enables or disables Fault Tolerance Circuit Breaker support.

Default client configuration:

quarkus.flow.http.client.resilience.circuit-breaker.enabled=true

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_ENABLED

Defines the ratio of failures in the rolling window that causes a closed circuit breaker to move to open.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_FAILURE_RATIO

Defines the size of the rolling window. That is, the number of recent consecutive invocations tracked by a closed circuit breaker.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_REQUEST_VOLUME_THRESHOLD

Defines the number of probe invocations allowed when the circuit breaker is half-open. If they all succeed, the circuit breaker moves to closed, otherwise it moves back to open.

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_SUCCESS_THRESHOLD

The delay after which an open circuit breaker moves to half-open.

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_DELAY

Defines the set of exception types considered failure.

The comparison is based on the fully qualified class name of the exception. Subclasses are also considered a match.

Default client configuration:

Named client configuration:

Example:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_RESILIENCE_CIRCUIT_BREAKER_EXCEPTIONS

Whether the HTTP Client should propagate through HTTP headers the correlation metadata.

The correlation metadata are:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_ENABLE_METADATA_PROPAGATION

Enables or disables metrics collection for Quarkus Flow.

When set to false, no metrics are published.

Restart required: Changing this property requires an application restart to take effect.

Environment variable: QUARKUS_FLOW_METRICS_ENABLED

Prefix applied to all exported metric names.

This allows distinguishing Quarkus Flow metrics from other application or framework metrics.

Please, configure a prefix separating words by (.) dot character.

Restart required: Changing this property requires an application restart to take effect.

Naming conventions.

Environment variable: QUARKUS_FLOW_METRICS_PREFIX

Enables or disables the duration distribution statistics (the histogram and the configured percentiles).

The duration Timer is always registered and recorded, so its base statistics (count, total time, and max) are published regardless of this setting. When set to false, only the histogram and percentiles are omitted; the exact representation of these statistics in the backend depends on the configured Micrometer registry (for example, Prometheus or an OpenTelemetry bridge).

Restart required: Changing this property requires an application restart to take effect.

Environment variable: QUARKUS_FLOW_METRICS_DURATIONS_ENABLED

Percentiles to be calculated for duration metrics.

Values must be in the range (0, 1), for example: 0.5, 0.95, 0.99.

Restart required: Changing this property requires an application restart to take effect.

Environment variable: QUARKUS_FLOW_METRICS_DURATIONS_PERCENTILES

Name of the custom io.quarkus.credentials.CredentialsProvider bean name to use as a global source for Workflow Secrets. This means that every io.serverlessworkflow.impl.WorkflowDefinition will use the same credential provider.

Environment variable: QUARKUS_FLOW_SECRETS_CREDENTIALS_PROVIDER_NAME

Specific custom io.quarkus.credentials.CredentialsProvider per workflow secret definition. In this case, you can specify one credential provider per io.serverlessworkflow.impl.WorkflowDefinition secret. Use the secret name as a key, e.g.:

Environment variable: QUARKUS_FLOW_SECRETS_CREDENTIALS_PROVIDER_NAMES__CREDENTIALS_PROVIDER_NAMES_

Enables or disables structured logging for Quarkus Flow.

When enabled, all workflow lifecycle events are emitted as structured JSON logs to stdout. This allows exporting workflow execution data to external databases for querying and analytics.

Default: false (users must opt-in)

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_ENABLED

Events to capture and log.

Supports glob patterns:

Default: workflow.* (all events)

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_EVENTS

Include task input/output payloads in task events.

When false (default), task events only include execution metadata (taskName, status, timing) but not input/output data. This keeps logs small and is sufficient for execution graph visualization.

When true, task events include full input/output data, useful for detailed auditing or debugging.

Default: false

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_INCLUDE_TASK_PAYLOADS

Include workflow input/output payloads in workflow events.

When false, workflow events only include execution metadata. When true (default), workflow events include full input/output data.

Default: true

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_INCLUDE_WORKFLOW_PAYLOADS

Always include full context in error events.

When true (default), task failure and workflow failure events include full input data and error details, regardless of include-task-payloads() setting.

This ensures errors are fully debuggable even when payload logging is disabled.

Default: true

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_INCLUDE_ERROR_CONTEXT

Max stack trace lines to include in error events.

Only read when include-error-context() is true.

Default: 10

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_STACK_TRACE_MAX_LINES

Maximum size (in bytes) for payloads before truncation.

Large payloads (e.g., agentic contexts with conversation history) are truncated to prevent overwhelming log systems. Truncated data includes metadata about original size and a preview.

Default: 10240 (10KB)

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_PAYLOAD_MAX_SIZE

Size (in bytes) of preview included in truncated payloads.

When a payload exceeds payload-max-size(), a preview of this size is included to give context about the truncated data.

Default: 1024 (1KB)

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_TRUNCATE_PREVIEW_SIZE

Log level for structured events.

Default: INFO

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_LOG_LEVEL

Timestamp format for structured logging events.

Controls the format of all timestamp fields (timestamp, startTime, endTime, lastUpdateTime).

Default: iso8601

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_TIMESTAMP_FORMAT

Custom timestamp pattern for DateTimeFormatter.

Only used when timestamp-format() is CUSTOM.

Example patterns:

If timestamp-format is CUSTOM and this is not set or invalid, the application will fail at startup with IllegalArgumentException.

Environment variable: QUARKUS_FLOW_STRUCTURED_LOGGING_TIMESTAMP_PATTERN

Whether to enable workflow execution tracing. If not set, it defaults to true in dev and test mode.

Environment variable: QUARKUS_FLOW_TRACING_ENABLED

Connect timeout in milliseconds.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__CONNECT_TIMEOUT

Read timeout in milliseconds.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__READ_TIMEOUT

Maximum size of the HTTP connection pool (number of concurrent connections).

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__CONNECTION_POOL_SIZE

Whether HTTP keep-alive is enabled.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__KEEP_ALIVE_ENABLED

Connection time-to-live in seconds.

After this time, idle connections can be closed and reestablished.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__CONNECTION_TTL

Quarkus REST client name used when the underlying HTTP client is shared.

This name corresponds to the Vert.x HTTP client name and is only used when shared() is true.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__NAME

Whether this HTTP client is shared with other Quarkus REST clients.

When true, the underlying Vert.x HttpClient can be reused across multiple REST clients based on the name().

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__SHARED

Maximum number of redirects allowed for a request.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__MAX_REDIRECTS

Maximum size of all HTTP headers for HTTP/1.x, in bytes.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__MAX_HEADER_SIZE

Maximum length of the initial HTTP/1.x request line, in bytes.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__MAX_INITIAL_LINE_LENGTH

HTTP User-Agent header to use for requests.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__USER_AGENT

Enables HTTP/2 for this client when set to true.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__HTTP2

Enables ALPN (Application-Layer Protocol Negotiation) for this client when set to true.

ALPN is typically required for HTTP/2 over TLS.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__ALPN

Whether to capture the stack trace of REST client invocations.

This is mainly useful for debugging and error reporting, at the cost of some overhead.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__CAPTURE_STACKTRACE

Logging scope for the underlying REST client.

Supported values (case-insensitive):

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__LOGGING_SCOPE

Maximum number of characters of the request/response body to log.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__LOGGING_BODY_LIMIT

Static HTTP headers to apply to every request by this client.

The value is parsed as a comma-separated list of name=value pairs, for example:

For a named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__STATIC_HEADERS

The name of the proxy configuration to use for configuring HTTP proxy.

Default client:

Named client:

There are some rules for using proxy configuration:

Use the value none to disable using the default configuration defined via quarkus.proxy.*.

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__PROXY_CONFIGURATION_NAME

Whether the client should automatically follow HTTP redirects.

When true, 3xx responses are transparently followed up to max-redirects().

Default client:

Named client:

Internally mapped to ClientBuilderImpl.followRedirects(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__FOLLOW_REDIRECTS

Whether HTTP compression is enabled.

When true, the client advertises support for compressed responses and transparently decompresses them when supported by the server.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.enableCompression(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__ENABLE_COMPRESSION

Maximum HTTP chunk size in bytes.

This controls the underlying Vert.x HTTP parser chunk size. For most users the default is sufficient; only adjust if you need fine-grained control over streaming behaviour.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.maxChunkSize(int).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__MAX_CHUNK_SIZE

Maximum content length (in bytes) for HTTP/2 clear-text upgrade (h2c).

Controls the threshold used when upgrading HTTP/1.1 connections to HTTP/2 without TLS.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.http2UpgradeMaxContentLength(int).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__HTTP2_UPGRADE_MAX_CONTENT_LENGTH

How multiple query parameters with the same name are encoded.

Valid values correspond to org.jboss.resteasy.reactive.common.jaxrs.MultiQueryParamMode: for example COMMA, DUPLICATE, ARRAY.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.multiQueryParamMode(MultiQueryParamMode).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__MULTI_QUERY_PARAM_MODE

Whether to trust all TLS certificates.

Warning: enabling this effectively disables certificate validation and should only be used in development or controlled environments.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.trustAll(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__TRUST_ALL

Whether to verify the remote TLS hostname.

When false, hostname verification is disabled. This is insecure and should only be used in development or with great care in production.

Default client:

Named client:

Internally mapped to ClientBuilderImpl.verifyHost(boolean).

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__VERIFY_HOST

Identifier of the TypeGuard<CompletionStage<WorkflowModel>> implementation to be used by this HTTP client.

Default client:

Named client:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_IDENTIFIER

Defines the maximum number of retries for a task execution.

The value must be greater than or equal to -1.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_RETRY_MAX_RETRIES

Enables or disables Fault Tolerance retry support.

When enabled, failed task executions may be retried according to the configured retry policy.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_RETRY_ENABLED

Defines the delay between retry attempts.

The delay is applied only after a failed execution and before a retry attempt is performed.

The initial execution is not delayed. The delay applies only to subsequent retry attempts.

A value of 0 disables the delay, causing retries to be executed immediately.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_RETRY_DELAY

Defines the jitter bound applied to the delay between retry attempts.

A random value in the range from -jitter to +jitter is added to the configured retry delay. This helps to avoid retry bursts when multiple tasks fail simultaneously.

The jitter is applied only to retry attempts. The initial execution is not affected.

A value of 0 disables jitter, causing the retry delay to be applied without any random variation.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_RETRY_JITTER

Defines the exception types that trigger a retry.

When the execution throws an exception whose type matches one of the configured values, the retry mechanism is applied.

The comparison is based on the fully qualified class name of the exception. Subclasses are also considered a match.

Default client configuration:

Named client configuration:

Example:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_RETRY_EXCEPTIONS

Enables or disables Fault Tolerance Circuit Breaker support.

Default client configuration:

quarkus.flow.http.client.resilience.circuit-breaker.enabled=true

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_ENABLED

Defines the ratio of failures in the rolling window that causes a closed circuit breaker to move to open.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_FAILURE_RATIO

Defines the size of the rolling window. That is, the number of recent consecutive invocations tracked by a closed circuit breaker.

Default client configuration:

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_REQUEST_VOLUME_THRESHOLD

Defines the number of probe invocations allowed when the circuit breaker is half-open. If they all succeed, the circuit breaker moves to closed, otherwise it moves back to open.

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_SUCCESS_THRESHOLD

The delay after which an open circuit breaker moves to half-open.

Named client configuration:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_DELAY

Defines the set of exception types considered failure.

The comparison is based on the fully qualified class name of the exception. Subclasses are also considered a match.

Default client configuration:

Named client configuration:

Example:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_NAMED__NAMED__RESILIENCE_CIRCUIT_BREAKER_EXCEPTIONS

Client name to use for all HTTP/OpenAPI tasks in this workflow when there is no task-level override.

Property:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_WORKFLOW__WORKFLOW__NAME

Client name to use for this specific task.

Property:

Environment variable: QUARKUS_FLOW_HTTP_CLIENT_WORKFLOW__WORKFLOW__TASK__TASK__NAME

Register default consumer/publisher beans bound to 'flow-in'/'flow-out' channels

Environment variable: QUARKUS_FLOW_MESSAGING_DEFAULTS_ENABLED

Register the default events lifecycle publisher to the 'flow-lifecycle-out'. By default, the application won’t publish any lifecycle event to this channel.

Environment variable: QUARKUS_FLOW_MESSAGING_LIFECYCLE_ENABLED

Whether the emitters should propagate correlation metadata.

When enabled, correlation metadata attributes are automatically added to emitted CloudEvents to enable traceability and correlation across workflow instances and tasks.

The default correlation metadata includes:

Environment variable: QUARKUS_FLOW_MESSAGING_ENABLE_METADATA_CORRELATION

The metadata’s key name to be used in correlation propagation.

This defines the actual extension context attribute’s key name that will be used in the emitted CloudEvents.

Environment variable: QUARKUS_FLOW_MESSAGING_METADATA_TASK_ID_KEY

The metadata’s key name to be used in correlation propagation.

This defines the actual extension context attribute’s key name that will be used in the emitted CloudEvents.

Environment variable: QUARKUS_FLOW_MESSAGING_METADATA_INSTANCE_ID_KEY

If true, enables the dev-mode/test-mode/local-mode strategy that avoids querying the K8s cluster when in dev mode or testing profiles or executing in an environment without Kubernetes access. Defaults to true.

Enable it ONLY if you can mock the Kubernetes objects required for the durable use case. In normal conditions, you will NEVER disable this property.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_LOCAL_LOCAL_STRATEGY_ENABLED

Duration, in seconds, for the Lease object to wait to renew the lock

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_LEASE_MEMBER_DURATION

Whether to remove this node from trying to renew the lease

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_LEASE_MEMBER_ENABLED

Duration, in seconds, for the Lease object to wait to renew the lock

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_LEASE_LEADER_DURATION

Whether to remove this node from trying to renew the lease

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_LEASE_LEADER_ENABLED

It’s highly recommended that users set this property to not have objects clashing on Kubernetes.

The group pool name used to create the Lease objects coordination on the cluster. It’s used to name and label every object created by the pool.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_POOL_NAME

Interval of the controller reconcile cycle set on ISO-8601 format. This interval marks how much time the internal controller must run.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_SCHEDULERS_LEADER_INTERVAL

Unless strictly necessary, don’t set this property. It governs the initial time in seconds for the scheduler to start running. It defaults to "random" to avoid pilling up API requests to the Kubernetes server.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_SCHEDULERS_LEADER_INITIAL_DELAY

Interval of the controller reconcile cycle set on ISO-8601 format. This interval marks how much time the internal controller must run.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_SCHEDULERS_MEMBER_INTERVAL

Unless strictly necessary, don’t set this property. It governs the initial time in seconds for the scheduler to start running. It defaults to "random" to avoid pilling up API requests to the Kubernetes server.

Environment variable: QUARKUS_FLOW_DURABLE_KUBE_SCHEDULERS_MEMBER_INITIAL_DELAY

Enable auto restoration of stored workflow instances after restart

Environment variable: QUARKUS_FLOW_PERSISTENCE_AUTO_RESTORE

List of workflow IDs to exclude from persistence, in namespace:name:version format. Workflows in this list will execute in-memory only and will not be persisted.

Example: quarkus.flow.persistence.exclude-workflows=com.example:workflow:0.1.0,org.acme:workflow:1.2.0

Environment variable: QUARKUS_FLOW_PERSISTENCE_EXCLUDE_WORKFLOWS

Path of the file holding MVStore data in the file system

Environment variable: QUARKUS_FLOW_PERSISTENCE_MVSTORE_DB_PATH

Enable or disable the Flow Runner feature.

When false, all runner REST endpoints are disabled and workflow definitions are not loaded from the configured source.

This is the master switch for the entire runner functionality.

Environment variable: QUARKUS_FLOW_RUNNER_ENABLED

Filesystem path to workflow definitions.

Required when type=PATH. The directory is scanned recursively for all .yaml, .yml, and .json files.

In Kubernetes/OpenShift deployments, this typically points to a ConfigMap or persistent volume mount:

Workflows are uniquely identified by namespace:name:version. Duplicate workflow identifiers cause application startup to fail.

Environment variable: QUARKUS_FLOW_RUNNER_SOURCE_PATH

Authentication type.

Selects which authentication mechanism to use:

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_TYPE

The API key secret value.

Should be loaded from environment variables or Kubernetes Secrets:

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_API_KEYS__API_KEYS__SECRET

Roles assigned to this API key.

Predefined roles:

Example:

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_API_KEYS__API_KEYS__ROLES

Namespaces allowed for this API key.

When not configured (empty), the key has access to all namespaces. When configured, the key can only access workflows in the specified namespaces.

Example:

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_API_KEYS__API_KEYS__NAMESPACES

JWT claim name containing authorized namespace(s).

Used when type=OIDC. The claim can contain:

Example:

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_NAMESPACE_CLAIM

Enable or disable namespace validation.

When true, requests are validated against the namespace in the request path and the user’s authorized namespaces (from JWT claim or API key configuration).

When false, namespace validation is skipped (all users can access all namespaces). Use only in development.

Environment variable: QUARKUS_FLOW_RUNNER_SECURITY_NAMESPACE_VALIDATE

Enable or disable dynamic workflow operations in OpenAPI document.

When true, the OpenAPI document will include a concrete operation for each registered workflow definition. For example, a workflow test-namespace:hello-world:1.0.0 will generate:

When false, only the generic parameterized endpoint is documented.

Security Note: The OpenAPI document (/q/openapi) is publicly accessible and will show all registered workflows (namespace, name, version, summary). This serves as a public workflow catalog. Actual execution remains protected by authentication and namespace authorization, returning 401/403 for unauthorized access attempts.

Exposed Information:

NOT Exposed:

Environment variable: QUARKUS_FLOW_RUNNER_OPENAPI_EXPAND_WORKFLOWS