Extension Configuration Reference

Directory where to look for Workflow definition files.

It is relative to src/main directory.

If you set by example workflows, the Workflow definitions must be located in src/main/workflows.

Environment variable: QUARKUS_FLOW_DEFINITIONS_DIR

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

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

Environment variable: QUARKUS_FLOW_TRACING_ENABLED

Enables or disables metrics collection for Quarkus Flow.

When set to false, no metrics are published.

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.

Naming conventions.

Environment variable: QUARKUS_FLOW_METRICS_PREFIX

Enables or disables duration metrics.

When disabled, no timing metrics (such as workflow or task execution durations) are published.

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.

Environment variable: QUARKUS_FLOW_METRICS_DURATIONS_PERCENTILES

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

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_

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