Agroal - Database connection pool |
Type |
Default |
quarkus.datasource."datasource-name".jdbc
If we create a JDBC datasource for this datasource.
Environment variable: QUARKUS_DATASOURCE_JDBC
|
boolean |
true
|
quarkus.datasource.jdbc.driver
quarkus.datasource."datasource-name".jdbc.driver
The datasource driver class name
Environment variable: QUARKUS_DATASOURCE_JDBC_DRIVER
|
string |
|
quarkus.datasource.jdbc.transactions
quarkus.datasource."datasource-name".jdbc.transactions
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing javax.sql.XADataSource .
Environment variable: QUARKUS_DATASOURCE_JDBC_TRANSACTIONS
|
|
enabled
|
quarkus.datasource.jdbc.enable-metrics
quarkus.datasource."datasource-name".jdbc.enable-metrics
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active.
Environment variable: QUARKUS_DATASOURCE_JDBC_ENABLE_METRICS
|
boolean |
|
quarkus.datasource.jdbc.tracing
quarkus.datasource."datasource-name".jdbc.tracing
Enable JDBC tracing. Disabled by default.
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING
|
boolean |
false
|
quarkus.datasource.jdbc.telemetry
quarkus.datasource."datasource-name".jdbc.telemetry
Enable OpenTelemetry JDBC instrumentation.
Environment variable: QUARKUS_DATASOURCE_JDBC_TELEMETRY
|
boolean |
false
|
quarkus.datasource.jdbc.url
quarkus.datasource."datasource-name".jdbc.url
Environment variable: QUARKUS_DATASOURCE_JDBC_URL
|
string |
|
quarkus.datasource.jdbc.initial-size
quarkus.datasource."datasource-name".jdbc.initial-size
The initial size of the pool. Usually you will want to set the initial size to match at least the minimal size, but this is not enforced so to allow for architectures which prefer a lazy initialization of the connections on boot, while being able to sustain a minimal pool size after boot.
Environment variable: QUARKUS_DATASOURCE_JDBC_INITIAL_SIZE
|
int |
|
quarkus.datasource.jdbc.min-size
quarkus.datasource."datasource-name".jdbc.min-size
The datasource pool minimum size
Environment variable: QUARKUS_DATASOURCE_JDBC_MIN_SIZE
|
int |
0
|
quarkus.datasource.jdbc.max-size
quarkus.datasource."datasource-name".jdbc.max-size
The datasource pool maximum size
Environment variable: QUARKUS_DATASOURCE_JDBC_MAX_SIZE
|
int |
20
|
quarkus.datasource.jdbc.background-validation-interval
quarkus.datasource."datasource-name".jdbc.background-validation-interval
The interval at which we validate idle connections in the background.
Set to 0 to disable background validation.
Environment variable: QUARKUS_DATASOURCE_JDBC_BACKGROUND_VALIDATION_INTERVAL
|
Duration |
2M
|
quarkus.datasource.jdbc.foreground-validation-interval
quarkus.datasource."datasource-name".jdbc.foreground-validation-interval
Perform foreground validation on connections that have been idle for longer than the specified interval.
Environment variable: QUARKUS_DATASOURCE_JDBC_FOREGROUND_VALIDATION_INTERVAL
|
Duration |
|
quarkus.datasource.jdbc.acquisition-timeout
quarkus.datasource."datasource-name".jdbc.acquisition-timeout
The timeout before cancelling the acquisition of a new connection
Environment variable: QUARKUS_DATASOURCE_JDBC_ACQUISITION_TIMEOUT
|
Duration |
5S
|
quarkus.datasource.jdbc.leak-detection-interval
quarkus.datasource."datasource-name".jdbc.leak-detection-interval
The interval at which we check for connection leaks.
Environment variable: QUARKUS_DATASOURCE_JDBC_LEAK_DETECTION_INTERVAL
|
Duration |
This feature is disabled by default.
|
quarkus.datasource.jdbc.idle-removal-interval
quarkus.datasource."datasource-name".jdbc.idle-removal-interval
The interval at which we try to remove idle connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_IDLE_REMOVAL_INTERVAL
|
Duration |
5M
|
quarkus.datasource.jdbc.max-lifetime
quarkus.datasource."datasource-name".jdbc.max-lifetime
The max lifetime of a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_MAX_LIFETIME
|
Duration |
By default, there is no restriction on the lifespan of a connection.
|
quarkus.datasource.jdbc.transaction-isolation-level
quarkus.datasource."datasource-name".jdbc.transaction-isolation-level
The transaction isolation level.
Environment variable: QUARKUS_DATASOURCE_JDBC_TRANSACTION_ISOLATION_LEVEL
|
undefined , none , read-uncommitted , read-committed , repeatable-read , serializable
|
|
quarkus.datasource.jdbc.extended-leak-report
quarkus.datasource."datasource-name".jdbc.extended-leak-report
Collect and display extra troubleshooting info on leaked connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_EXTENDED_LEAK_REPORT
|
boolean |
false
|
quarkus.datasource.jdbc.flush-on-close
quarkus.datasource."datasource-name".jdbc.flush-on-close
Allows connections to be flushed upon return to the pool. It’s not enabled by default.
Environment variable: QUARKUS_DATASOURCE_JDBC_FLUSH_ON_CLOSE
|
boolean |
false
|
quarkus.datasource.jdbc.detect-statement-leaks
quarkus.datasource."datasource-name".jdbc.detect-statement-leaks
When enabled, Agroal will be able to produce a warning when a connection is returned to the pool without the application having closed all open statements. This is unrelated with tracking of open connections. Disable for peak performance, but only when there’s high confidence that no leaks are happening.
Environment variable: QUARKUS_DATASOURCE_JDBC_DETECT_STATEMENT_LEAKS
|
boolean |
true
|
quarkus.datasource.jdbc.new-connection-sql
quarkus.datasource."datasource-name".jdbc.new-connection-sql
Query executed when first using a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_NEW_CONNECTION_SQL
|
string |
|
quarkus.datasource.jdbc.validation-query-sql
quarkus.datasource."datasource-name".jdbc.validation-query-sql
Query executed to validate a connection.
Environment variable: QUARKUS_DATASOURCE_JDBC_VALIDATION_QUERY_SQL
|
string |
|
quarkus.datasource.jdbc.validate-on-borrow
quarkus.datasource."datasource-name".jdbc.validate-on-borrow
Forces connection validation prior to acquisition (foreground validation) regardless of the idle status.
Because of the overhead of performing validation on every call, it’s recommended to rely on default idle validation instead, and to leave this to false .
Environment variable: QUARKUS_DATASOURCE_JDBC_VALIDATE_ON_BORROW
|
boolean |
false
|
quarkus.datasource.jdbc.pooling-enabled
quarkus.datasource."datasource-name".jdbc.pooling-enabled
Disable pooling to prevent reuse of Connections. Use this when an external pool manages the life-cycle of Connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_POOLING_ENABLED
|
boolean |
true
|
quarkus.datasource.jdbc.transaction-requirement
quarkus.datasource."datasource-name".jdbc.transaction-requirement
Require an active transaction when acquiring a connection. Recommended for production. WARNING: Some extensions acquire connections without holding a transaction for things like schema updates and schema validation. Setting this setting to STRICT may lead to failures in those cases.
Environment variable: QUARKUS_DATASOURCE_JDBC_TRANSACTION_REQUIREMENT
|
|
|
quarkus.datasource.jdbc.additional-jdbc-properties."property-key"
quarkus.datasource."datasource-name".jdbc.additional-jdbc-properties."property-key"
Other unspecified properties to be passed to the JDBC driver when creating new connections.
Environment variable: QUARKUS_DATASOURCE_JDBC_ADDITIONAL_JDBC_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.datasource.jdbc.tracing.enabled
quarkus.datasource."datasource-name".jdbc.tracing.enabled
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_ENABLED
|
boolean |
false if quarkus.datasource.jdbc.tracing=false and true if quarkus.datasource.jdbc.tracing=true
|
quarkus.datasource.jdbc.tracing.trace-with-active-span-only
quarkus.datasource."datasource-name".jdbc.tracing.trace-with-active-span-only
Trace calls with active Spans only
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_TRACE_WITH_ACTIVE_SPAN_ONLY
|
boolean |
false
|
quarkus.datasource.jdbc.tracing.ignore-for-tracing
quarkus.datasource."datasource-name".jdbc.tracing.ignore-for-tracing
Ignore specific queries from being traced
Environment variable: QUARKUS_DATASOURCE_JDBC_TRACING_IGNORE_FOR_TRACING
|
string |
Ignore specific queries from being traced, multiple queries can be specified separated by semicolon, double quotes should be escaped with \
|
quarkus.datasource.jdbc.telemetry.enabled
quarkus.datasource."datasource-name".jdbc.telemetry.enabled
Enable OpenTelemetry JDBC instrumentation.
Environment variable: QUARKUS_DATASOURCE_JDBC_TELEMETRY_ENABLED
|
boolean |
false if quarkus.datasource.jdbc.telemetry=false and true if quarkus.datasource.jdbc.telemetry=true
|
Amazon Lambda - Common Deployment |
Type |
Default |
quarkus.lambda.mock-event-server.enabled
Setting to true will start event server even if quarkus.devservices.enabled=false
Environment variable: QUARKUS_LAMBDA_MOCK_EVENT_SERVER_ENABLED
|
boolean |
true
|
quarkus.lambda.mock-event-server.dev-port
Port to access mock event server in dev mode
Environment variable: QUARKUS_LAMBDA_MOCK_EVENT_SERVER_DEV_PORT
|
int |
8080
|
quarkus.lambda.mock-event-server.test-port
Port to access mock event server in dev mode
Environment variable: QUARKUS_LAMBDA_MOCK_EVENT_SERVER_TEST_PORT
|
int |
8081
|
quarkus.lambda.expected-exceptions
The exception classes expected to be thrown by the handler. Any exception thrown by the handler that is an instance of a class in this list will not be logged, but will otherwise be handled normally by the lambda runtime. This is useful for avoiding unnecessary stack traces while preserving the ability to log unexpected exceptions.
Environment variable: QUARKUS_LAMBDA_EXPECTED_EXCEPTIONS
|
list of Class |
|
The handler name. Handler names are specified on handler classes using the @jakarta.inject.Named annotation. If this name is unspecified and there is exactly one unnamed implementation of com.amazonaws.services.lambda.runtime.RequestHandler then this unnamed handler will be used. If there is only a single named handler and the name is unspecified then the named handler will be used.
Environment variable: QUARKUS_LAMBDA_HANDLER
|
string |
|
Amazon Lambda AWS Gateway REST API |
Type |
Default |
quarkus.lambda-http.enable-security
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
Environment variable: QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY
|
boolean |
false
|
quarkus.lambda-http.map-cognito-to-roles
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
Environment variable: QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES
|
boolean |
true
|
quarkus.lambda-http.cognito-role-claim
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
Environment variable: QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM
|
string |
cognito:groups
|
quarkus.lambda-http.cognito-claim-matcher
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "[^\[\] \t]+"
Environment variable: QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER
|
string |
[^\[\] \t]+
|
Amazon Lambda HTTP |
Type |
Default |
quarkus.lambda-http.enable-security
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway
Environment variable: QUARKUS_LAMBDA_HTTP_ENABLE_SECURITY
|
boolean |
false
|
quarkus.lambda-http.map-cognito-to-roles
If true, runtime will search Cognito JWT claims for "cognito:groups" and add them as Quarkus security roles. True by default
Environment variable: QUARKUS_LAMBDA_HTTP_MAP_COGNITO_TO_ROLES
|
boolean |
true
|
quarkus.lambda-http.cognito-role-claim
Cognito claim that contains roles you want to map. Defaults to "cognito:groups"
Environment variable: QUARKUS_LAMBDA_HTTP_COGNITO_ROLE_CLAIM
|
string |
cognito:groups
|
quarkus.lambda-http.cognito-claim-matcher
Regular expression to locate role values within a Cognito claim string. By default it looks for space delimited strings enclosed in brackets "[^\[\] \t]+"
Environment variable: QUARKUS_LAMBDA_HTTP_COGNITO_CLAIM_MATCHER
|
string |
[^\[\] \t]+
|
ArC |
Type |
Default |
quarkus.arc.remove-unused-beans
-
If set to all (or true ) the container will attempt to remove all unused beans.
-
If set to none (or false ) no beans will ever be removed even if they are unused (according to the criteria set out below)
-
If set to fwk , then all unused beans will be removed, except the unused beans whose classes are declared in the application code
-
is not a built-in bean or interceptor,
-
is not eligible for injection to any injection point,
-
is not excluded by any extension,
-
does not have a name,
-
does not declare an observer,
-
does not declare any producer which is eligible for injection to any injection point,
-
is not directly eligible for injection into any jakarta.enterprise.inject.Instance injection point
Environment variable: QUARKUS_ARC_REMOVE_UNUSED_BEANS
|
string |
all
|
quarkus.arc.auto-inject-fields
If set to true @Inject is automatically added to all non-static non-final fields that are annotated with one of the annotations defined by AutoInjectAnnotationBuildItem .
Environment variable: QUARKUS_ARC_AUTO_INJECT_FIELDS
|
boolean |
true
|
quarkus.arc.transform-unproxyable-classes
If set to true, the bytecode of unproxyable beans will be transformed. This ensures that a proxy/subclass can be created properly. If the value is set to false, then an exception is thrown at build time indicating that a subclass/proxy could not be created. Quarkus performs the following transformations when this setting is enabled:
-
Remove 'final' modifier from classes and methods when a proxy is required.
-
Create a no-args constructor if needed.
-
Makes private no-args constructors package-private if necessary.
Environment variable: QUARKUS_ARC_TRANSFORM_UNPROXYABLE_CLASSES
|
boolean |
true
|
quarkus.arc.transform-private-injected-fields
If set to true, the bytecode of private fields that are injection points will be transformed to package private. This ensures that field injection can be performed completely reflection-free. If the value is set to false, then a reflection fallback is used to perform the injection.
Environment variable: QUARKUS_ARC_TRANSFORM_PRIVATE_INJECTED_FIELDS
|
boolean |
true
|
quarkus.arc.fail-on-intercepted-private-method
If set to true (the default), the build fails if a private method that is neither an observer nor a producer, is annotated with an interceptor binding. An example of this is the use of Transactional on a private method of a bean. If set to false, Quarkus simply logs a warning that the annotation will be ignored.
Environment variable: QUARKUS_ARC_FAIL_ON_INTERCEPTED_PRIVATE_METHOD
|
boolean |
true
|
quarkus.arc.selected-alternatives
The list of selected alternatives for an application.
-
a fully qualified class name, i.e. org.acme.Foo
-
a simple class name as defined by Class#getSimpleName() , i.e. Foo
-
a package name with suffix .* , i.e. org.acme.* , matches a package
-
a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value Each element value is used to match an alternative bean class, an alternative stereotype annotation type or a bean class that declares an alternative producer. If any value matches then the priority of Integer#MAX_VALUE is used for the relevant bean. The priority declared via jakarta.annotation.Priority is overridden.
Environment variable: QUARKUS_ARC_SELECTED_ALTERNATIVES
|
list of string |
|
quarkus.arc.auto-producer-methods
If set to true then jakarta.enterprise.inject.Produces is automatically added to all non-void methods that are annotated with a scope annotation, a stereotype or a qualifier, and are not annotated with Inject or Produces , and no parameter is annotated with Disposes , Observes or ObservesAsync .
Environment variable: QUARKUS_ARC_AUTO_PRODUCER_METHODS
|
boolean |
true
|
quarkus.arc.exclude-types
The list of types that should be excluded from discovery.
-
a fully qualified class name, i.e. org.acme.Foo
-
a simple class name as defined by Class#getSimpleName() , i.e. Foo
-
a package name with suffix .* , i.e. org.acme.* , matches a package
-
a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value If any element value matches a discovered type then the type is excluded from discovery, i.e. no beans and observer methods are created from this type.
Environment variable: QUARKUS_ARC_EXCLUDE_TYPES
|
list of string |
|
quarkus.arc.unremovable-types
List of types that should be considered unremovable regardless of whether they are directly used or not. This is a configuration option equivalent to using io.quarkus.arc.Unremovable annotation.
-
a fully qualified class name, i.e. org.acme.Foo
-
a simple class name as defined by Class#getSimpleName() , i.e. Foo
-
a package name with suffix .* , i.e. org.acme.* , matches a package
-
a package name with suffix .** , i.e. org.acme.** , matches a package that starts with the value If any element value matches a discovered bean, then such a bean is considered unremovable.
Environment variable: QUARKUS_ARC_UNREMOVABLE_TYPES
|
list of string |
|
quarkus.arc.exclude-dependency."dependency-name"
Artifacts that should be excluded from discovery
Environment variable: QUARKUS_ARC_EXCLUDE_DEPENDENCY__DEPENDENCY_NAME_
|
Map<String,IndexDependencyConfig> |
|
quarkus.arc.detect-unused-false-positives
If set to true then the container attempts to detect "unused removed beans" false positives during programmatic lookup at runtime. You can disable this feature to conserve some memory when running your application in production.
Environment variable: QUARKUS_ARC_DETECT_UNUSED_FALSE_POSITIVES
|
boolean |
true
|
quarkus.arc.detect-wrong-annotations
If set to true then the container attempts to detect wrong usages of annotations and eventually fails the build to prevent unexpected behavior of a Quarkus application.
A typical example is @jakarta.ejb.Singleton which is often confused with @jakarta.inject.Singleton . As a result a component annotated with @jakarta.ejb.Singleton would be completely ignored. Another example is an inner class annotated with a scope annotation - this component would be again completely ignored.
Environment variable: QUARKUS_ARC_DETECT_WRONG_ANNOTATIONS
|
boolean |
true
|
quarkus.arc.strict-compatibility
If set to true , the container will perform additional validations mandated by the CDI specification. Some improvements on top of the CDI specification may be disabled. Applications that work as expected in the strict mode should work without a change in the default, non-strict mode.
The strict mode is mainly introduced to allow passing the CDI Lite TCK. Applications are recommended to use the default, non-strict mode, which makes CDI more convenient to use. The "strictness" of the strict mode (the set of additional validations and the set of disabled improvements on top of the CDI specification) may change over time.
Note that transform-unproxyable-classes and remove-unused-beans also has effect on specification compatibility. You may want to disable these features to get behavior closer to the specification.
Environment variable: QUARKUS_ARC_STRICT_COMPATIBILITY
|
boolean |
false
|
quarkus.arc.dev-mode.monitoring-enabled
If set to true then the container monitors business method invocations and fired events during the development mode.
|
This config property should not be changed in the development mode as it requires a full rebuild of the application
|
Environment variable: QUARKUS_ARC_DEV_MODE_MONITORING_ENABLED
|
boolean |
false
|
quarkus.arc.dev-mode.generate-dependency-graphs
If set to true then the dependency graphs are generated and available in the Dev UI.
Environment variable: QUARKUS_ARC_DEV_MODE_GENERATE_DEPENDENCY_GRAPHS
|
boolean |
true
|
quarkus.arc.test.disable-application-lifecycle-observers
If set to true then disable StartupEvent and ShutdownEvent observers declared on application bean classes during the tests.
Environment variable: QUARKUS_ARC_TEST_DISABLE_APPLICATION_LIFECYCLE_OBSERVERS
|
boolean |
false
|
quarkus.arc.ignored-split-packages
The list of packages that will not be checked for split package issues.
A package string representation can be:
-
a full name of the package, i.e. org.acme.foo
-
a package name with suffix .* , i.e. org.acme.* , which matches a package that starts with provided value
Environment variable: QUARKUS_ARC_IGNORED_SPLIT_PACKAGES
|
list of string |
|
quarkus.arc.context-propagation.enabled
If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by means of the MicroProfile Context Propagation API. Specifically, a org.eclipse.microprofile.context.spi.ThreadContextProvider implementation is registered. On the other hand, if set to false then the MicroProfile Context Propagation API will never be used to propagate the CDI contexts. Note that the CDI contexts may be propagated in a different way though. For example with the Vertx duplicated context.
Environment variable: QUARKUS_ARC_CONTEXT_PROPAGATION_ENABLED
|
boolean |
true
|
Azure Functions |
Type |
Default |
quarkus.azure-functions.app-name
App name for azure function project. This is required setting. Defaults to the base artifact name
Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_NAME
|
string |
|
quarkus.azure-functions.resource-group
Azure Resource Group for your Azure Functions
Environment variable: QUARKUS_AZURE_FUNCTIONS_RESOURCE_GROUP
|
string |
quarkus
|
quarkus.azure-functions.region
Specifies the region where your Azure Functions will be hosted; default value is westus. Valid values
Environment variable: QUARKUS_AZURE_FUNCTIONS_REGION
|
string |
westus
|
quarkus.azure-functions.disable-app-insights
Specifies whether to disable application insights for your function app
Environment variable: QUARKUS_AZURE_FUNCTIONS_DISABLE_APP_INSIGHTS
|
boolean |
false
|
quarkus.azure-functions.app-insights-key
Specifies the instrumentation key of application insights which will bind to your function app
Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_INSIGHTS_KEY
|
string |
|
quarkus.azure-functions.runtime.os
Valid values are linux, windows, and docker
Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_OS
|
string |
linux
|
quarkus.azure-functions.runtime.java-version
Valid values are 8, 11, and 17
Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_JAVA_VERSION
|
string |
11
|
quarkus.azure-functions.runtime.image
URL of docker image if deploying via docker
Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_IMAGE
|
string |
|
quarkus.azure-functions.runtime.registry-url
If using docker, url of registry
Environment variable: QUARKUS_AZURE_FUNCTIONS_RUNTIME_REGISTRY_URL
|
string |
|
quarkus.azure-functions.auth.type
Description of each type can be found here Valid values are
-
azure_cli Delegates to Azure CLI for login
-
managed_identity Requires client to be set
-
oauth2 Requires tenant to be set
-
device_code Requires tenant to be set
-
file Filesystem path to a property file that defines authentication. Properties supported are
-
type Supports same type values as well as service_principal
-
client
-
tenant
-
key Password for service_principal if using password authentication
-
certificate Path to PEM file if using service_principal
-
certificate-password Password for PEM file if it is password protected and if using service_principal
-
environment if using service_principal Defaults to "azure_cli" for authentication
Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_TYPE
|
string |
azure_cli
|
quarkus.azure-functions.auth.path
Filesystem path to properties file if using file type
Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_PATH
|
string |
|
quarkus.azure-functions.auth.client
Client or App Id required if using managed_identity type
Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_CLIENT
|
string |
|
quarkus.azure-functions.auth.tenant
Tenant Id required if using oauth2 or device_code type
Environment variable: QUARKUS_AZURE_FUNCTIONS_AUTH_TENANT
|
string |
|
quarkus.azure-functions.app-service-plan-name
Specifies the name of the existing App Service Plan when you do not want to create a new one.
Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_SERVICE_PLAN_NAME
|
string |
java-functions-app-service-plan
|
quarkus.azure-functions.app-service-plan-resource-group
The app service plan resource group.
Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_SERVICE_PLAN_RESOURCE_GROUP
|
string |
|
quarkus.azure-functions.subscription-id
Azure subscription id. Required only if there are more than one subscription in your account
Environment variable: QUARKUS_AZURE_FUNCTIONS_SUBSCRIPTION_ID
|
string |
|
quarkus.azure-functions.pricing-tier
Environment variable: QUARKUS_AZURE_FUNCTIONS_PRICING_TIER
|
string |
|
quarkus.azure-functions.func-port
Port to run azure function in local runtime. Will default to quarkus.http.test-port or 8081
Environment variable: QUARKUS_AZURE_FUNCTIONS_FUNC_PORT
|
int |
|
quarkus.azure-functions.local-debug-config
Config String for local debug
Environment variable: QUARKUS_AZURE_FUNCTIONS_LOCAL_DEBUG_CONFIG
|
string |
transport=dt_socket,server=y,suspend=n,address=5005
|
quarkus.azure-functions.app-settings."setting-name"
Specifies the application settings for your Azure Functions, which are defined in name-value pairs
Environment variable: QUARKUS_AZURE_FUNCTIONS_APP_SETTINGS__SETTING_NAME_
|
Map<String,String> |
|
Cache |
Type |
Default |
Environment variable: QUARKUS_CACHE_TYPE
|
string |
caffeine
|
Whether or not the cache extension is enabled.
Environment variable: QUARKUS_CACHE_ENABLED
|
boolean |
true
|
Default configuration applied to all Caffeine caches (lowest precedence) |
Type |
Default |
quarkus.cache.caffeine.initial-capacity
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory.
Environment variable: QUARKUS_CACHE_CAFFEINE_INITIAL_CAPACITY
|
int |
|
quarkus.cache.caffeine.maximum-size
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often.
Environment variable: QUARKUS_CACHE_CAFFEINE_MAXIMUM_SIZE
|
long |
|
quarkus.cache.caffeine.expire-after-write
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.
Environment variable: QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_WRITE
|
Duration |
|
quarkus.cache.caffeine.expire-after-access
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read.
Environment variable: QUARKUS_CACHE_CAFFEINE_EXPIRE_AFTER_ACCESS
|
Duration |
|
quarkus.cache.caffeine.metrics-enabled
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to true will enable the accumulation of cache stats inside Caffeine.
Environment variable: QUARKUS_CACHE_CAFFEINE_METRICS_ENABLED
|
boolean |
|
quarkus.cache.caffeine."cache-name".initial-capacity
Minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory.
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__INITIAL_CAPACITY
|
int |
|
quarkus.cache.caffeine."cache-name".maximum-size
Maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often.
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__MAXIMUM_SIZE
|
long |
|
quarkus.cache.caffeine."cache-name".expire-after-write
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_WRITE
|
Duration |
|
quarkus.cache.caffeine."cache-name".expire-after-access
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read.
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__EXPIRE_AFTER_ACCESS
|
Duration |
|
quarkus.cache.caffeine."cache-name".metrics-enabled
Whether or not metrics are recorded if the application depends on the Micrometer extension. Setting this value to true will enable the accumulation of cache stats inside Caffeine.
Environment variable: QUARKUS_CACHE_CAFFEINE__CACHE_NAME__METRICS_ENABLED
|
boolean |
|
Container Image |
Type |
Default |
quarkus.container-image.group
The group the container image will be part of
Environment variable: QUARKUS_CONTAINER_IMAGE_GROUP
|
string |
|
quarkus.container-image.name
The name of the container image. If not set defaults to the application name
Environment variable: QUARKUS_CONTAINER_IMAGE_NAME
|
string |
${quarkus.application.name:unset}
|
quarkus.container-image.tag
The tag of the container image. If not set defaults to the application version
Environment variable: QUARKUS_CONTAINER_IMAGE_TAG
|
string |
${quarkus.application.version:latest}
|
quarkus.container-image.additional-tags
Additional tags of the container image.
Environment variable: QUARKUS_CONTAINER_IMAGE_ADDITIONAL_TAGS
|
list of string |
|
quarkus.container-image.labels."label-name"
Custom labels to add to the generated image.
Environment variable: QUARKUS_CONTAINER_IMAGE_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.container-image.registry
The container registry to use
Environment variable: QUARKUS_CONTAINER_IMAGE_REGISTRY
|
string |
|
quarkus.container-image.image
Represents the entire image string. If set, then group , name , registry , tags , additionalTags are ignored
Environment variable: QUARKUS_CONTAINER_IMAGE_IMAGE
|
string |
|
quarkus.container-image.username
The username to use to authenticate with the registry where the built image will be pushed
Environment variable: QUARKUS_CONTAINER_IMAGE_USERNAME
|
string |
|
quarkus.container-image.password
The password to use to authenticate with the registry where the built image will be pushed
Environment variable: QUARKUS_CONTAINER_IMAGE_PASSWORD
|
string |
|
quarkus.container-image.insecure
Whether or not insecure registries are allowed
Environment variable: QUARKUS_CONTAINER_IMAGE_INSECURE
|
boolean |
false
|
quarkus.container-image.build
Whether or not a image build will be performed.
Environment variable: QUARKUS_CONTAINER_IMAGE_BUILD
|
boolean |
|
quarkus.container-image.push
Whether or not an image push will be performed.
Environment variable: QUARKUS_CONTAINER_IMAGE_PUSH
|
boolean |
|
quarkus.container-image.builder
The name of the container image extension to use (e.g. docker, podman, jib, s2i). The option will be used in case multiple extensions are present.
Environment variable: QUARKUS_CONTAINER_IMAGE_BUILDER
|
string |
|
Container Image - Buildpack |
Type |
Default |
quarkus.buildpack.jvm-builder-image
The buildpacks builder image to use when building the project in jvm mode.
Environment variable: QUARKUS_BUILDPACK_JVM_BUILDER_IMAGE
|
string |
|
quarkus.buildpack.native-builder-image
The buildpacks builder image to use when building the project in jvm mode.
Environment variable: QUARKUS_BUILDPACK_NATIVE_BUILDER_IMAGE
|
string |
|
quarkus.buildpack.builder-env."environment-variable-name"
Environment key/values to pass to buildpacks.
Environment variable: QUARKUS_BUILDPACK_BUILDER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.buildpack.run-image
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image.
Environment variable: QUARKUS_BUILDPACK_RUN_IMAGE
|
string |
|
quarkus.buildpack.pull-timeout-seconds
Max pull timeout for builder/run images, in seconds
Environment variable: QUARKUS_BUILDPACK_PULL_TIMEOUT_SECONDS
|
int |
300
|
quarkus.buildpack.docker-host
DOCKER_HOST value to use. If not set, the env var DOCKER_HOST is used, if that is not set the value `unix:///var/run/docker.sock' (or 'npipe:///./pipe/docker_engine' for windows) is used.
Environment variable: QUARKUS_BUILDPACK_DOCKER_HOST
|
string |
|
quarkus.buildpack.log-level
Log level to use.. Defaults to 'info'
Environment variable: QUARKUS_BUILDPACK_LOG_LEVEL
|
string |
info
|
quarkus.buildpack.base-registry-username
The username to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_BUILDPACK_BASE_REGISTRY_USERNAME
|
string |
|
quarkus.buildpack.base-registry-password
The password to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_BUILDPACK_BASE_REGISTRY_PASSWORD
|
string |
|
Container Image - Docker |
Type |
Default |
quarkus.docker.dockerfile-jvm-path
Environment variable: QUARKUS_DOCKER_DOCKERFILE_JVM_PATH
|
string |
src/main/docker/Dockerfile.jvm
|
quarkus.docker.dockerfile-native-path
Environment variable: QUARKUS_DOCKER_DOCKERFILE_NATIVE_PATH
|
string |
src/main/docker/Dockerfile.native
|
quarkus.docker.build-args."arg-name"
Environment variable: QUARKUS_DOCKER_BUILD_ARGS__ARG_NAME_
|
Map<String,String> |
|
quarkus.docker.cache-from
Environment variable: QUARKUS_DOCKER_CACHE_FROM
|
list of string |
|
Environment variable: QUARKUS_DOCKER_NETWORK
|
string |
|
quarkus.docker.executable-name
Environment variable: QUARKUS_DOCKER_EXECUTABLE_NAME
|
string |
|
quarkus.docker.additional-args
Environment variable: QUARKUS_DOCKER_ADDITIONAL_ARGS
|
list of string |
|
Configuration for Docker Buildx options |
Type |
Default |
quarkus.docker.buildx.platform
Environment variable: QUARKUS_DOCKER_BUILDX_PLATFORM
|
list of string |
|
quarkus.docker.buildx.output
Environment variable: QUARKUS_DOCKER_BUILDX_OUTPUT
|
string |
|
quarkus.docker.buildx.progress
Environment variable: QUARKUS_DOCKER_BUILDX_PROGRESS
|
string |
|
Container Image - Jib |
Type |
Default |
quarkus.jib.base-jvm-image
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, registry.access.redhat.com/ubi8/openjdk-21-runtime:1.20 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-17-runtime:1.20 is used as the default.
Environment variable: QUARKUS_JIB_BASE_JVM_IMAGE
|
string |
|
quarkus.jib.base-native-image
The base image to be used when a container image is being produced for the native binary build. The default is "quay.io/quarkus/quarkus-micro-image". You can also use "registry.access.redhat.com/ubi8/ubi-minimal" which is a bigger base image, but provide more built-in utilities such as the microdnf package manager.
Environment variable: QUARKUS_JIB_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/quarkus-micro-image:2.0
|
quarkus.jib.jvm-arguments
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_JIB_JVM_ARGUMENTS
|
list of string |
-Djava.util.logging.manager=org.jboss.logmanager.LogManager
|
quarkus.jib.jvm-additional-arguments
Additional JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_JIB_JVM_ADDITIONAL_ARGUMENTS
|
list of string |
|
quarkus.jib.native-arguments
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_JIB_NATIVE_ARGUMENTS
|
list of string |
|
quarkus.jib.jvm-entrypoint
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
-
Entrypoint "INHERIT" means to inherit entrypoint from base image, jvmArguments field is used for arguments
-
A valid entrypoint is jar package specific (see quarkus.package.jar.type )
-
A valid entrypoint depends on the location of both the launching scripts and the application jar file. To that end it’s helpful to remember that when fast-jar packaging is used (the default), all necessary application jars are added to the /work directory and that the same directory is also used as the working directory. When legacy-jar or uber-jar are used, the application jars are unpacked under the /app directory and that directory is used as the working directory.
-
Even if the jvmArguments field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive
Environment variable: QUARKUS_JIB_JVM_ENTRYPOINT
|
list of string |
|
quarkus.jib.native-entrypoint
If this is set, then it will be used as the entry point of the container image. There are a few things to be aware of when creating an entry point
-
Entrypoint "INHERIT" means to inherit entrypoint from base image, nativeArguments field is used for arguments
-
A valid entrypoint depends on the location of both the launching scripts and the native binary file. To that end it’s helpful to remember that the native application is added to the /work directory and that and the same directory is also used as the working directory
-
Even if the nativeArguments field is set, it is ignored completely unless entrypoint is "INHERIT" When this is not set, a proper default entrypoint will be constructed. As a final note, a very useful tool for inspecting container image layers that can greatly aid when debugging problems with endpoints is dive
Environment variable: QUARKUS_JIB_NATIVE_ENTRYPOINT
|
list of string |
|
quarkus.jib.environment-variables."environment-variable-name"
Environment variables to add to the container image
Environment variable: QUARKUS_JIB_ENVIRONMENT_VARIABLES__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.jib.base-registry-username
The username to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_JIB_BASE_REGISTRY_USERNAME
|
string |
|
quarkus.jib.base-registry-password
The password to use to authenticate with the registry used to pull the base JVM image
Environment variable: QUARKUS_JIB_BASE_REGISTRY_PASSWORD
|
string |
|
Environment variable: QUARKUS_JIB_PORTS
|
list of int |
${quarkus.http.port:8080}
|
The user to use in generated image
Environment variable: QUARKUS_JIB_USER
|
string |
|
quarkus.jib.working-directory
The working directory to use in the generated image. The default value is chosen to work in accordance with the default base image.
Environment variable: QUARKUS_JIB_WORKING_DIRECTORY
|
string |
/home/jboss
|
quarkus.jib.always-cache-base-image
Controls the optimization which skips downloading base image layers that exist in a target registry. If the user does not set this property, then read as false. If true , base image layers are always pulled and cached. If false , base image layers will not be pulled/cached if they already exist on the target registry.
Environment variable: QUARKUS_JIB_ALWAYS_CACHE_BASE_IMAGE
|
boolean |
false
|
List of target platforms. Each platform is defined using the pattern:
<os>|<arch>[/variant]|<os>/<arch>[/variant]
linux/amd64,linux/arm64/v8
If not specified, OS default is linux and architecture default is amd64 . If more than one platform is configured, it is important to note that the base image has to be a Docker manifest or an OCI image index containing a version of each chosen platform. The feature does not work with native images, as cross-compilation is not supported. This configuration is based on an incubating feature of Jib. See Jib FAQ for more information.
Environment variable: QUARKUS_JIB_PLATFORMS
|
list of string |
|
quarkus.jib.image-digest-file
The path of a file in which the digest of the generated image will be written. If the path is relative, the base path is the output directory of the build tool.
Environment variable: QUARKUS_JIB_IMAGE_DIGEST_FILE
|
string |
jib-image.digest
|
quarkus.jib.image-id-file
The path of a file in which the id of the generated image will be written. If the path is relative, the base path is the output directory of the build tool.
Environment variable: QUARKUS_JIB_IMAGE_ID_FILE
|
string |
jib-image.id
|
Whether or not to operate offline.
Environment variable: QUARKUS_JIB_OFFLINE_MODE
|
boolean |
false
|
quarkus.jib.docker-executable-name
Name of binary used to execute the docker commands. This is only used by Jib when the container image is being built locally.
Environment variable: QUARKUS_JIB_DOCKER_EXECUTABLE_NAME
|
string |
|
quarkus.jib.docker-environment."environment-variable-name"
Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally.
Environment variable: QUARKUS_JIB_DOCKER_ENVIRONMENT__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.jib.use-current-timestamp
Whether to set the creation time to the actual build time. Otherwise, the creation time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). See Jib FAQ for more information
Environment variable: QUARKUS_JIB_USE_CURRENT_TIMESTAMP
|
boolean |
true
|
quarkus.jib.use-current-timestamp-file-modification
Whether to set the modification time (last modified time) of the files put by Jib in the image to the actual build time. Otherwise, the modification time will be set to the Unix epoch (00:00:00, January 1st, 1970 in UTC). If the modification time is constant (flag is set to false so Unix epoch is used) across two consecutive builds, the docker layer sha256 digest will be different only if the actual files added by Jib to the docker layer were changed. More exactly, having 2 consecutive builds will generate different docker layers only if the actual content of the files within the docker layer was changed. If the current timestamp is used the sha256 digest of the docker layer will always be different even if the content of the files didn’t change.
Environment variable: QUARKUS_JIB_USE_CURRENT_TIMESTAMP_FILE_MODIFICATION
|
boolean |
true
|
quarkus.jib.base-image-layers-cache
The directory to use for caching base image layers. If not specified, the Jib default directory is used.
Environment variable: QUARKUS_JIB_BASE_IMAGE_LAYERS_CACHE
|
string |
|
quarkus.jib.application-layers-cache
The directory to use for caching application layers. If not specified, the Jib default directory is used.
Environment variable: QUARKUS_JIB_APPLICATION_LAYERS_CACHE
|
string |
|
Container Image - OpenShift |
Type |
Default |
quarkus.openshift.build-strategy
The build config strategy to use.
Environment variable: QUARKUS_OPENSHIFT_BUILD_STRATEGY
|
|
binary
|
quarkus.openshift.base-jvm-image
The base image to be used when a container image is being produced for the jar build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead. When the application is built against Java 21 or higher, registry.access.redhat.com/ubi8/openjdk-21:1.20 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-17:1.20 is used as the default.
Environment variable: QUARKUS_OPENSHIFT_BASE_JVM_IMAGE
|
string |
|
quarkus.openshift.base-native-image
The base image to be used when a container image is being produced for the native binary build. The value of this property is used to create an ImageStream for the builder image used in the Openshift build. When it references images already available in the internal Openshift registry, the corresponding streams are used instead.
Environment variable: QUARKUS_OPENSHIFT_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0
|
quarkus.openshift.jvm-dockerfile
The default Dockerfile to use for jvm builds
Environment variable: QUARKUS_OPENSHIFT_JVM_DOCKERFILE
|
string |
src/main/docker/Dockerfile.jvm
|
quarkus.openshift.native-dockerfile
The default Dockerfile to use for native builds
Environment variable: QUARKUS_OPENSHIFT_NATIVE_DOCKERFILE
|
string |
src/main/docker/Dockerfile.native
|
quarkus.openshift.jvm-arguments
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_OPENSHIFT_JVM_ARGUMENTS
|
list of string |
|
quarkus.openshift.native-arguments
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_OPENSHIFT_NATIVE_ARGUMENTS
|
list of string |
|
quarkus.openshift.jar-directory
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.
Environment variable: QUARKUS_OPENSHIFT_JAR_DIRECTORY
|
string |
|
quarkus.openshift.jar-file-name
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.
Environment variable: QUARKUS_OPENSHIFT_JAR_FILE_NAME
|
string |
|
quarkus.openshift.native-binary-directory
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.
Environment variable: QUARKUS_OPENSHIFT_NATIVE_BINARY_DIRECTORY
|
string |
|
quarkus.openshift.native-binary-file-name
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.
Environment variable: QUARKUS_OPENSHIFT_NATIVE_BINARY_FILE_NAME
|
string |
|
quarkus.openshift.build-timeout
Environment variable: QUARKUS_OPENSHIFT_BUILD_TIMEOUT
|
Duration |
PT5M
|
quarkus.openshift.build-log-level
The log level of OpenShift build log.
Environment variable: QUARKUS_OPENSHIFT_BUILD_LOG_LEVEL
|
fatal , error , warn , info , debug , trace
|
info
|
quarkus.openshift.image-push-secret
Environment variable: QUARKUS_OPENSHIFT_IMAGE_PUSH_SECRET
|
string |
|
quarkus.s2i.build-strategy
The build config strategy to use.
Environment variable: QUARKUS_S2I_BUILD_STRATEGY
|
|
binary
|
quarkus.s2i.base-jvm-image
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 21 or higher, registry.access.redhat.com/ubi8/openjdk-21:1.20 is used as the default. Otherwise registry.access.redhat.com/ubi8/openjdk-17:1.20 is used as the default.
Environment variable: QUARKUS_S2I_BASE_JVM_IMAGE
|
string |
|
quarkus.s2i.base-native-image
The base image to be used when a container image is being produced for the native binary build
Environment variable: QUARKUS_S2I_BASE_NATIVE_IMAGE
|
string |
quay.io/quarkus/ubi-quarkus-native-binary-s2i:2.0
|
quarkus.s2i.jvm-arguments
The JVM arguments to pass to the JVM when starting the application
Environment variable: QUARKUS_S2I_JVM_ARGUMENTS
|
list of string |
|
quarkus.s2i.native-arguments
Additional arguments to pass when starting the native application
Environment variable: QUARKUS_S2I_NATIVE_ARGUMENTS
|
list of string |
|
quarkus.s2i.jar-directory
The directory where the jar is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non default image is used.
Environment variable: QUARKUS_S2I_JAR_DIRECTORY
|
string |
/deployments/target/
|
quarkus.s2i.jar-file-name
The resulting filename of the jar in the S2I image. This option may be used if the selected S2I image uses a fixed name for the jar.
Environment variable: QUARKUS_S2I_JAR_FILE_NAME
|
string |
|
quarkus.s2i.native-binary-directory
The directory where the native binary is added during the assemble phase. This is dependent on the S2I image and should be supplied if a non-default image is used.
Environment variable: QUARKUS_S2I_NATIVE_BINARY_DIRECTORY
|
string |
/home/quarkus/
|
quarkus.s2i.native-binary-file-name
The resulting filename of the native binary in the S2I image. This option may be used if the selected S2I image uses a fixed name for the native binary.
Environment variable: QUARKUS_S2I_NATIVE_BINARY_FILE_NAME
|
string |
|
quarkus.s2i.build-timeout
Environment variable: QUARKUS_S2I_BUILD_TIMEOUT
|
Duration |
PT5M
|
Container Image - Podman |
Type |
Default |
quarkus.podman.dockerfile-jvm-path
Environment variable: QUARKUS_PODMAN_DOCKERFILE_JVM_PATH
|
string |
src/main/docker/Dockerfile.jvm
|
quarkus.podman.dockerfile-native-path
Environment variable: QUARKUS_PODMAN_DOCKERFILE_NATIVE_PATH
|
string |
src/main/docker/Dockerfile.native
|
quarkus.podman.build-args."arg-name"
Environment variable: QUARKUS_PODMAN_BUILD_ARGS__ARG_NAME_
|
Map<String,String> |
|
quarkus.podman.cache-from
Environment variable: QUARKUS_PODMAN_CACHE_FROM
|
list of string |
|
Environment variable: QUARKUS_PODMAN_NETWORK
|
string |
|
quarkus.podman.executable-name
Environment variable: QUARKUS_PODMAN_EXECUTABLE_NAME
|
string |
|
quarkus.podman.additional-args
Environment variable: QUARKUS_PODMAN_ADDITIONAL_ARGS
|
list of string |
|
Environment variable: QUARKUS_PODMAN_PLATFORM
|
list of string |
|
Core |
Type |
Default |
Set to enable native-image building using GraalVM.
Environment variable: QUARKUS_NATIVE_ENABLED
|
boolean |
false
|
quarkus.native.sources-only
Set to prevent the native-image process from actually building the native image.
Environment variable: QUARKUS_NATIVE_SOURCES_ONLY
|
boolean |
false
|
quarkus.native.additional-build-args
Comma-separated, additional arguments to pass to the build process. If an argument includes the , symbol, it needs to be escaped, e.g. \\,
Environment variable: QUARKUS_NATIVE_ADDITIONAL_BUILD_ARGS
|
list of string |
|
quarkus.native.enable-http-url-handler
If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs
Environment variable: QUARKUS_NATIVE_ENABLE_HTTP_URL_HANDLER
|
boolean |
true
|
quarkus.native.enable-https-url-handler
If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs
Environment variable: QUARKUS_NATIVE_ENABLE_HTTPS_URL_HANDLER
|
boolean |
false
|
The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries.
Environment variable: QUARKUS_NATIVE_HEADLESS
|
boolean |
true
|
quarkus.native.file-encoding
Defines the file encoding as in -Dfile.encoding=… . Native image runtime uses the host’s (i.e. build time) value of file.encoding system property. We intentionally default this to UTF-8 to avoid platform specific defaults to be picked up which can then result in inconsistent behavior in the generated native executable.
Environment variable: QUARKUS_NATIVE_FILE_ENCODING
|
string |
UTF-8
|
quarkus.native.add-all-charsets
If all character sets should be added to the native executable.
Note that some extensions (e.g. the Oracle JDBC driver) also take this setting into account to enable support for all charsets at the extension level.
This increases image size.
Environment variable: QUARKUS_NATIVE_ADD_ALL_CHARSETS
|
boolean |
false
|
quarkus.native.graalvm-home
The location of the Graal distribution
Environment variable: QUARKUS_NATIVE_GRAALVM_HOME
|
string |
${GRAALVM_HOME:}
|
Environment variable: QUARKUS_NATIVE_JAVA_HOME
|
File |
${java.home}
|
quarkus.native.native-image-xmx
The maximum Java heap to be used during the native image generation
Environment variable: QUARKUS_NATIVE_NATIVE_IMAGE_XMX
|
string |
|
quarkus.native.debug-build-process
If the native image build should wait for a debugger to be attached before running. This is an advanced option and is generally only intended for those familiar with GraalVM internals
Environment variable: QUARKUS_NATIVE_DEBUG_BUILD_PROCESS
|
boolean |
false
|
quarkus.native.publish-debug-build-process-port
If the debug port should be published when building with docker and debug-build-process is true
Environment variable: QUARKUS_NATIVE_PUBLISH_DEBUG_BUILD_PROCESS_PORT
|
boolean |
true
|
quarkus.native.enable-isolates
If isolates should be enabled
Environment variable: QUARKUS_NATIVE_ENABLE_ISOLATES
|
boolean |
true
|
quarkus.native.enable-fallback-images
If a JVM based 'fallback image' should be created if native image fails. This is not recommended, as this is functionally the same as just running the application in a JVM
Environment variable: QUARKUS_NATIVE_ENABLE_FALLBACK_IMAGES
|
boolean |
false
|
quarkus.native.auto-service-loader-registration
If all META-INF/services entries should be automatically registered
Environment variable: QUARKUS_NATIVE_AUTO_SERVICE_LOADER_REGISTRATION
|
boolean |
false
|
quarkus.native.dump-proxies
If the bytecode of all proxies should be dumped for inspection
Environment variable: QUARKUS_NATIVE_DUMP_PROXIES
|
boolean |
false
|
quarkus.native.container-build
If this build should be done using a container runtime. Unless container-runtime is also set, docker will be used by default. If docker is not available or is an alias to podman, podman will be used instead as the default.
Environment variable: QUARKUS_NATIVE_CONTAINER_BUILD
|
boolean |
|
Explicit configuration option to generate a native Position Independent Executable (PIE) for Linux. If the system supports PIE generation, the default behaviour is to disable it for performance reasons. However, some systems can only run position-independent executables, so this option enables the generation of such native executables.
Environment variable: QUARKUS_NATIVE_PIE
|
boolean |
|
Generate instructions for a specific machine type. Defaults to x86-64-v3 on AMD64 and armv8-a on AArch64. Use compatibility for best compatibility, or native for best performance if a native executable is deployed on the same machine or on a machine with the same CPU features. A list of all available machine types is available by executing native-image -march=list
Environment variable: QUARKUS_NATIVE_MARCH
|
string |
|
quarkus.native.remote-container-build
If this build is done using a remote docker daemon.
Environment variable: QUARKUS_NATIVE_REMOTE_CONTAINER_BUILD
|
boolean |
false
|
quarkus.native.builder-image
The docker image to use to do the image build. It can be one of graalvm , mandrel , or the full image path, e.g. quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21 .
Environment variable: QUARKUS_NATIVE_BUILDER_IMAGE
|
string |
mandrel
|
quarkus.native.builder-image.pull
The strategy for pulling the builder image during the build.
Defaults to 'always', which will always pull the most up-to-date image; useful to keep up with fixes when a (floating) tag is updated.
Use 'missing' to only pull if there is no image locally; useful on development environments where building with out-of-date images is acceptable and bandwidth may be limited.
Use 'never' to fail the build if there is no image locally.
Environment variable: QUARKUS_NATIVE_BUILDER_IMAGE_PULL
|
|
always
|
quarkus.native.container-runtime
The container runtime (e.g. docker) that is used to do an image based build. If this is set then a container build is always done.
Environment variable: QUARKUS_NATIVE_CONTAINER_RUNTIME
|
docker , docker-rootless , wsl , wsl-rootless , podman , podman-rootless , unavailable
|
|
quarkus.native.container-runtime-options
Options to pass to the container runtime
Environment variable: QUARKUS_NATIVE_CONTAINER_RUNTIME_OPTIONS
|
list of string |
|
quarkus.native.monitoring
Enable monitoring various monitoring options. The value should be comma separated.
-
jfr for JDK flight recorder support
-
jvmstat for JVMStat support
-
heapdump for heampdump support
-
jmxclient for JMX client support (experimental)
-
jmxserver for JMX server support (experimental)
-
all for all monitoring features
Environment variable: QUARKUS_NATIVE_MONITORING
|
list of heapdump , jvmstat , jfr , jmxserver , jmxclient , all
|
|
quarkus.native.enable-reports
If the reports on call paths and included packages/classes/methods should be generated
Environment variable: QUARKUS_NATIVE_ENABLE_REPORTS
|
boolean |
false
|
quarkus.native.report-exception-stack-traces
If exceptions should be reported with a full stack trace
Environment variable: QUARKUS_NATIVE_REPORT_EXCEPTION_STACK_TRACES
|
boolean |
true
|
quarkus.native.report-errors-at-runtime
If errors should be reported at runtime. This is a more relaxed setting, however it is not recommended as it means your application may fail at runtime if an unsupported feature is used by accident.
Environment variable: QUARKUS_NATIVE_REPORT_ERRORS_AT_RUNTIME
|
boolean |
false
|
quarkus.native.reuse-existing
Don’t build a native image if it already exists. This is useful if you have already built an image and you want to use Quarkus to deploy it somewhere. Note that this is not able to detect if the existing image is outdated, if you have modified source or config and want a new image you must not use this flag.
Environment variable: QUARKUS_NATIVE_REUSE_EXISTING
|
boolean |
false
|
quarkus.native.resources.includes
A comma separated list of globs to match resource paths that should be added to the native image.
Use slash (/ ) as a path separator on all platforms. Globs must not start with slash.
By default, no resources are included.
Example: Given that you have src/main/resources/ignored.png and src/main/resources/foo/selected.png in your source tree and one of your dependency JARs contains bar/some.txt file, with the following configuration
quarkus.native.resources.includes = foo/**,bar/**/*.txt
the files src/main/resources/foo/selected.png and bar/some.txt will be included in the native image, while src/main/resources/ignored.png will not be included.
Supported glob features Feature Description * Matches a (possibly empty) sequence of characters that does not contain slash (/ ) ** Matches a (possibly empty) sequence of characters that may contain slash (/ ) ? Matches one character, but not slash [abc] Matches one character given in the bracket, but not slash [a-z] Matches one character from the range given in the bracket, but not slash [!abc] Matches one character not named in the bracket; does not match slash [a-z] Matches one character outside the range given in the bracket; does not match slash {one,two,three} Matches any of the alternating tokens separated by comma; the tokens may contain wildcards, nested alternations and ranges \ The escape character
Note that there are three levels of escaping when passing this option via application.properties :
-
application.properties parser
-
MicroProfile Config list converter that splits the comma separated list
-
Glob parser All three levels use backslash (\ ) as the escaping character. So you need to use an appropriate number of backslashes depending on which level you want to escape.
Note that Quarkus extensions typically include the resources they require by themselves. This option is useful in situations when the built-in functionality is not sufficient.
Environment variable: QUARKUS_NATIVE_RESOURCES_INCLUDES
|
list of string |
|
quarkus.native.resources.excludes
A comma separated list of globs to match resource paths that should not be added to the native image.
Use slash (/ ) as a path separator on all platforms. Globs must not start with slash.
Please refer to includes for details about the glob syntax.
By default, no resources are excluded.
Example: Given that you have src/main/resources/red.png and src/main/resources/foo/green.png in your source tree and one of your dependency JARs contains bar/blue.png file, with the following configuration
quarkus.native.resources.includes = **/*.png
quarkus.native.resources.excludes = foo/**,**/green.png
the resource red.png will be available in the native image while the resources foo/green.png and bar/blue.png will not be available in the native image.
Environment variable: QUARKUS_NATIVE_RESOURCES_EXCLUDES
|
list of string |
|
quarkus.native.debug.enabled
If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file.
Environment variable: QUARKUS_NATIVE_DEBUG_ENABLED
|
boolean |
false
|
quarkus.native.enable-dashboard-dump
Generate the report files for GraalVM Dashboard.
Environment variable: QUARKUS_NATIVE_ENABLE_DASHBOARD_DUMP
|
boolean |
false
|
quarkus.native.compression.level
The compression level in [1, 10]. 10 means best.
Higher compression level requires more time to compress the executable.
Environment variable: QUARKUS_NATIVE_COMPRESSION_LEVEL
|
int |
|
quarkus.native.compression.additional-args
Environment variable: QUARKUS_NATIVE_COMPRESSION_ADDITIONAL_ARGS
|
list of string |
|
quarkus.native.agent-configuration-apply
Configuration files generated by the Quarkus build, using native image agent, are informative by default. In other words, the generated configuration files are presented in the build log but are not applied. When this option is set to true, generated configuration files are applied to the native executable building process.
Enabling this option should be done with care, because it can make native image configuration and/or behaviour dependant on other non-obvious factors. For example, if the native image agent generated configuration was generated from running JVM unit tests, disabling test(s) can result in a different native image configuration being generated, which in turn can misconfigure the native executable or affect its behaviour in unintended ways.
Environment variable: QUARKUS_NATIVE_AGENT_CONFIGURATION_APPLY
|
boolean |
false
|
quarkus.bootstrap.effective-model-builder
If set to true, the workspace initialization will be based on the effective POMs (i.e. properly interpolated, including support for profiles) instead of the raw ones.
Environment variable: QUARKUS_BOOTSTRAP_EFFECTIVE_MODEL_BUILDER
|
boolean |
false
|
quarkus.bootstrap.workspace-discovery
If set to true, workspace discovery will be enabled for all launch modes. Usually, workspace discovery is enabled by default only for dev and test modes.
Environment variable: QUARKUS_BOOTSTRAP_WORKSPACE_DISCOVERY
|
boolean |
false
|
quarkus.bootstrap.warn-on-failing-workspace-modules
If set to true, workspace loader will log warnings for modules that could not be loaded for some reason instead of throwing errors.
Environment variable: QUARKUS_BOOTSTRAP_WARN_ON_FAILING_WORKSPACE_MODULES
|
boolean |
false
|
quarkus.bootstrap.disable-jar-cache
By default, the bootstrap mechanism will create a shared cache of open JARs for Quarkus classloaders to reduce the total number of opened ZIP FileSystems in dev and test modes. Setting system property quarkus.bootstrap.disable-jar-cache to true will make Quarkus classloaders create a new ZIP FileSystem for each JAR classpath element every time it is added to a Quarkus classloader.
Environment variable: QUARKUS_BOOTSTRAP_DISABLE_JAR_CACHE
|
boolean |
false
|
quarkus.bootstrap.incubating-model-resolver
A temporary option introduced to avoid a logging warning when ``-Dquarkus.bootstrap.incubating-model-resolver} is added to the build command line. This option enables an incubating implementation of the Quarkus Application Model resolver. This option will be removed as soon as the incubating implementation becomes the default one.
Environment variable: QUARKUS_BOOTSTRAP_INCUBATING_MODEL_RESOLVER
|
boolean |
false
|
quarkus.bootstrap.misaligned-platform-imports
Whether to throw an error, warn or silently ignore misaligned platform BOM imports
Environment variable: QUARKUS_BOOTSTRAP_MISALIGNED_PLATFORM_IMPORTS
|
|
error
|
quarkus.thread-pool.core-threads
The core thread pool size. This number of threads will always be kept alive.
Environment variable: QUARKUS_THREAD_POOL_CORE_THREADS
|
int |
1
|
quarkus.thread-pool.prefill
Prefill core thread pool. The core thread pool will be initialised with the core number of threads at startup
Environment variable: QUARKUS_THREAD_POOL_PREFILL
|
boolean |
true
|
quarkus.thread-pool.max-threads
The maximum number of threads. If this is not specified then it will be automatically sized to the greatest of 8 * the number of available processors and 200. For example if there are 4 processors the max threads will be 200. If there are 48 processors it will be 384.
Environment variable: QUARKUS_THREAD_POOL_MAX_THREADS
|
int |
|
quarkus.thread-pool.queue-size
The queue size. For most applications this should be unbounded
Environment variable: QUARKUS_THREAD_POOL_QUEUE_SIZE
|
int |
|
quarkus.thread-pool.growth-resistance
The executor growth resistance. A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of 0.0f implies that threads beyond the core size should be created as aggressively as threads within it; a value of 1.0f implies that threads beyond the core size should never be created.
Environment variable: QUARKUS_THREAD_POOL_GROWTH_RESISTANCE
|
float |
0f
|
quarkus.thread-pool.shutdown-timeout
The shutdown timeout. If all pending work has not been completed by this time then additional threads will be spawned to attempt to finish any pending tasks, and the shutdown process will continue
Environment variable: QUARKUS_THREAD_POOL_SHUTDOWN_TIMEOUT
|
Duration |
1M
|
quarkus.thread-pool.shutdown-interrupt
The amount of time to wait for thread pool shutdown before tasks should be interrupted. If this value is greater than or equal to the value for shutdown-timeout , then tasks will not be interrupted before the shutdown timeout occurs.
Environment variable: QUARKUS_THREAD_POOL_SHUTDOWN_INTERRUPT
|
Duration |
10S
|
quarkus.thread-pool.shutdown-check-interval
The frequency at which the status of the thread pool should be checked during shutdown. Information about waiting tasks and threads will be checked and possibly logged at this interval. Setting this key to an empty value disables the shutdown check interval.
Environment variable: QUARKUS_THREAD_POOL_SHUTDOWN_CHECK_INTERVAL
|
Duration |
5S
|
quarkus.thread-pool.keep-alive-time
The amount of time a thread will stay alive with no work.
Environment variable: QUARKUS_THREAD_POOL_KEEP_ALIVE_TIME
|
Duration |
30S
|
quarkus.devservices.enabled
Global flag that can be used to disable all Dev Services. If this is set to false then Dev Services will not be used.
Environment variable: QUARKUS_DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.devservices.launch-on-shared-network
Global flag that can be used to force the attachmment of Dev Services to shared network. Default is false.
Environment variable: QUARKUS_DEVSERVICES_LAUNCH_ON_SHARED_NETWORK
|
boolean |
false
|
quarkus.devservices.timeout
The timeout for starting a container
Environment variable: QUARKUS_DEVSERVICES_TIMEOUT
|
Duration |
|
quarkus.config.sources.system-only
Set this to true to read configuration from system properties and environment variables only. This only applies to runtime.
Environment variable: QUARKUS_CONFIG_SOURCES_SYSTEM_ONLY
|
boolean |
false
|
The set of supported locales that can be consumed by the extensions.
The locales must be specified in the IETF BCP 47 format e.g. en-US or fr-FR.
For instance, the Hibernate Validator extension makes use of it.
Native-image build uses it to define additional locales that are supposed to be available at runtime.
A special string "all" is translated as ROOT Locale and then used in native-image to include all locales. Image size penalty applies.
Environment variable: QUARKUS_LOCALES
|
list of Locale |
Set containing the build system locale
|
Default locale that can be consumed by the extensions.
The locale must be specified in the IETF BCP 47 format e.g. en-US or fr-FR.
For instance, the Hibernate Validator extension makes use of it.
Native-image build uses this property to derive user.language and user.country for the application’s runtime.
Environment variable: QUARKUS_DEFAULT_LOCALE
|
Locale |
Build system locale
|
The arguments passed to the command line.
We don’t make it a list as the args are separated by a space, not a comma.
Environment variable: QUARKUS_ARGS
|
string |
|
true to quit exit right after the initialization. The option is not meant be used directly by users.
Environment variable: QUARKUS_INIT_AND_EXIT
|
@io.smallrye.config.WithConverter(io.quarkus.runtime.init.InitRuntimeConfig.BooleanConverter.class) boolean |
false
|
The name of the application. If not set, defaults to the name of the project (except for tests where it is not set at all).
Environment variable: QUARKUS_APPLICATION_NAME
|
string |
|
quarkus.application.version
The version of the application. If not set, defaults to the version of the project (except for tests where it is not set at all).
Environment variable: QUARKUS_APPLICATION_VERSION
|
string |
|
quarkus.application.ui-header
The header to use for UI Screen (Swagger UI, GraphQL UI etc).
Environment variable: QUARKUS_APPLICATION_UI_HEADER
|
string |
{applicationName} (powered by Quarkus)
|
If set to true, Quarkus will perform re-augmentation (assuming the mutable-jar package type is used)
Environment variable: QUARKUS_LAUNCH_REBUILD
|
boolean |
false
|
Artifacts on the classpath that should also be indexed |
Type |
Default |
quarkus.index-dependency."dependency-name".group-id
The maven groupId of the artifact.
Environment variable: QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__GROUP_ID
|
string |
required |
quarkus.index-dependency."dependency-name".artifact-id
The maven artifactId of the artifact (optional).
Environment variable: QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__ARTIFACT_ID
|
string |
|
quarkus.index-dependency."dependency-name".classifier
The maven classifier of the artifact (optional).
Environment variable: QUARKUS_INDEX_DEPENDENCY__DEPENDENCY_NAME__CLASSIFIER
|
string |
|
quarkus.live-reload.enabled
Whether the live-reload feature should be enabled.
Environment variable: QUARKUS_LIVE_RELOAD_ENABLED
|
boolean |
true
|
quarkus.live-reload.instrumentation
Whether Quarkus should enable its ability to not do a full restart when changes to classes are compatible with JVM instrumentation. If this is set to true, Quarkus will perform class redefinition when possible.
Environment variable: QUARKUS_LIVE_RELOAD_INSTRUMENTATION
|
boolean |
false
|
quarkus.live-reload.watched-resources
The names of additional resource files to watch for changes, triggering a reload on change. Directories are not supported.
Environment variable: QUARKUS_LIVE_RELOAD_WATCHED_RESOURCES
|
list of string |
|
quarkus.live-reload.password
Password used to use to connect to the remote dev-mode application
Environment variable: QUARKUS_LIVE_RELOAD_PASSWORD
|
string |
|
URL used to use to connect to the remote dev-mode application
Environment variable: QUARKUS_LIVE_RELOAD_URL
|
string |
|
quarkus.live-reload.connect-timeout
The amount of time to wait for a remote dev connect or reconnect
Environment variable: QUARKUS_LIVE_RELOAD_CONNECT_TIMEOUT
|
Duration |
30S
|
quarkus.live-reload.retry-interval
The amount of time to wait between attempts when connecting to the server side of remote dev
Environment variable: QUARKUS_LIVE_RELOAD_RETRY_INTERVAL
|
Duration |
2S
|
quarkus.live-reload.retry-max-attempts
The maximum number of attempts when connecting to the server side of remote dev
Environment variable: QUARKUS_LIVE_RELOAD_RETRY_MAX_ATTEMPTS
|
int |
10
|
quarkus.jni.library-paths
Paths of library to load.
Environment variable: QUARKUS_JNI_LIBRARY_PATHS
|
list of string |
|
quarkus.naming.enable-jndi
By default, Quarkus will install a non-functional JNDI initial context, to help mitigate against Log4Shell style attacks. If your application does need to use JNDI you can change this flag.
Environment variable: QUARKUS_NAMING_ENABLE_JNDI
|
boolean |
false
|
quarkus.platform.group-id
groupId of the platform to use
Environment variable: QUARKUS_PLATFORM_GROUP_ID
|
string |
io.quarkus.platform
|
quarkus.platform.artifact-id
artifactId of the platform to use
Environment variable: QUARKUS_PLATFORM_ARTIFACT_ID
|
string |
quarkus-bom
|
version of the platform to use
Environment variable: QUARKUS_PLATFORM_VERSION
|
string |
999-SNAPSHOT
|
quarkus.package.jar.enabled
If set to false, no JAR will be produced.
Environment variable: QUARKUS_PACKAGE_JAR_ENABLED
|
boolean |
true
|
The JAR output type to use.
Environment variable: QUARKUS_PACKAGE_JAR_TYPE
|
fast-jar , uber-jar , mutable-jar , legacy-jar
|
fast-jar
|
quarkus.package.jar.compress
Whether the created jar will be compressed. This setting is not used when building a native image
Environment variable: QUARKUS_PACKAGE_JAR_COMPRESS
|
boolean |
true
|
quarkus.package.jar.manifest.add-implementation-entries
Specify whether the Implementation information should be included in the runner jar’s MANIFEST.MF.
Environment variable: QUARKUS_PACKAGE_JAR_MANIFEST_ADD_IMPLEMENTATION_ENTRIES
|
boolean |
true
|
quarkus.package.jar.manifest.attributes."attribute-name"
Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.attributes."Entry-key1"=Value1 quarkus.package.jar.manifest.attributes."Entry-key2"=Value2
Environment variable: QUARKUS_PACKAGE_JAR_MANIFEST_ATTRIBUTES__ATTRIBUTE_NAME_
|
Map<String,String> |
|
quarkus.package.jar.manifest.sections."section-name"
Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key1"=Value1 quarkus.package.jar.manifest.sections."Section-Name"."Entry-Key2"=Value2
Environment variable: QUARKUS_PACKAGE_JAR_MANIFEST_SECTIONS__SECTION_NAME_
|
Map<String,Map<String,String>> |
|
quarkus.package.jar.user-configured-ignored-entries
Files that should not be copied to the output artifact.
Environment variable: QUARKUS_PACKAGE_JAR_USER_CONFIGURED_IGNORED_ENTRIES
|
list of string |
|
quarkus.package.jar.included-optional-dependencies
List of all the dependencies that have been defined as optional to include into the final package of the application. Each optional dependency needs to be expressed in the following format:
groupId:artifactId[:[classifier][:[type]]]
With the classifier and type being optional (note that the brackets ([] ) denote optionality and are not a part of the syntax specification). The group ID and artifact ID must be present and non-empty.
If the type is missing, the artifact is assumed to be of type jar .
This parameter is optional; if absent, no optional dependencies will be included into the final package of the application.
For backward compatibility reasons, this parameter is ignored by default and can be enabled by setting the parameter quarkus.package.jar.filter-optional-dependencies to true .
This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies.
Environment variable: QUARKUS_PACKAGE_JAR_INCLUDED_OPTIONAL_DEPENDENCIES
|
list of GACT |
|
quarkus.package.jar.filter-optional-dependencies
Flag indicating whether the optional dependencies should be filtered out or not.
This parameter is meant to be used in modules where multi-builds have been configured to avoid getting a final package with unused dependencies.
Environment variable: QUARKUS_PACKAGE_JAR_FILTER_OPTIONAL_DEPENDENCIES
|
boolean |
false
|
quarkus.package.jar.add-runner-suffix
Indicates whether the generated JAR file should have the runner suffix appended. Only applicable to the JarType#UBER_JAR uber-JAR output type . If disabled, the JAR built by the original build system (Maven, Gradle, etc.) will be replaced with the Quarkus-built uber-JAR.
Environment variable: QUARKUS_PACKAGE_JAR_ADD_RUNNER_SUFFIX
|
boolean |
true
|
quarkus.package.jar.appcds.enabled
Whether to automate the creation of AppCDS. Furthermore, this option only works for Java 11+ and is considered experimental for the time being. Finally, care must be taken to use the same exact JVM version when building and running the application.
Environment variable: QUARKUS_PACKAGE_JAR_APPCDS_ENABLED
|
boolean |
false
|
quarkus.package.jar.appcds.builder-image
When AppCDS generation is enabled, if this property is set, then the JVM used to generate the AppCDS file will be the JVM present in the container image. The builder image is expected to have the 'java' binary on its PATH. This flag is useful when the JVM to be used at runtime is not the same exact JVM version as the one used to build the jar. Note that this property is consulted only when quarkus.package.jar.appcds.enabled=true and it requires having docker available during the build.
Environment variable: QUARKUS_PACKAGE_JAR_APPCDS_BUILDER_IMAGE
|
string |
|
quarkus.package.jar.appcds.use-container
Whether creation of the AppCDS archive should run in a container if available.
Normally, if either a suitable container image to use to create the AppCDS archive can be determined automatically or if one is explicitly set using the quarkus.<package-type>.appcds.builder-image setting, the AppCDS archive is generated by running the JDK contained in the image as a container.
If this option is set to false , a container will not be used to generate the AppCDS archive. Instead, the JDK used to build the application is also used to create the archive. Note that the exact same JDK version must be used to run the application in this case.
Ignored if quarkus.package.jar.appcds.enabled is set to false .
Environment variable: QUARKUS_PACKAGE_JAR_APPCDS_USE_CONTAINER
|
boolean |
true
|
quarkus.package.jar.user-providers-directory
This is an advanced option that only takes effect for development mode.
If this is specified a directory of this name will be created in the jar distribution. Users can place jar files in this directory, and when re-augmentation is performed these will be processed and added to the class-path.
Note that before reaugmentation has been performed these jars will be ignored, and if they are updated the app should be reaugmented again.
Environment variable: QUARKUS_PACKAGE_JAR_USER_PROVIDERS_DIRECTORY
|
string |
|
quarkus.package.jar.include-dependency-list
If this option is true then a list of all the coordinates of the artifacts that made up this image will be included in the quarkus-app directory. This list can be used by vulnerability scanners to determine if your application has any vulnerable dependencies. Only supported for the JarType#FAST_JAR fast JAR and JarType#MUTABLE_JAR mutable JAR output types.
Environment variable: QUARKUS_PACKAGE_JAR_INCLUDE_DEPENDENCY_LIST
|
boolean |
true
|
quarkus.package.jar.decompiler.enabled
Enable decompilation of generated and transformed bytecode into the decompiled directory.
Environment variable: QUARKUS_PACKAGE_JAR_DECOMPILER_ENABLED
|
boolean |
false
|
quarkus.package.jar.decompiler.jar-directory
The directory into which to save the decompilation tool if it doesn’t exist locally.
Environment variable: QUARKUS_PACKAGE_JAR_DECOMPILER_JAR_DIRECTORY
|
string |
${user.home}/.quarkus
|
quarkus.package.main-class
The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or io.quarkus.runtime.QuarkusApplication .
If your application has main classes annotated with io.quarkus.runtime.annotations.QuarkusMain then this can also reference the name given in the annotation, to avoid the need to specify fully qualified names in the config.
Environment variable: QUARKUS_PACKAGE_MAIN_CLASS
|
string |
|
quarkus.package.output-directory
The directory into which the output package(s) should be written. Relative paths are resolved from the build systems target directory.
Environment variable: QUARKUS_PACKAGE_OUTPUT_DIRECTORY
|
path |
|
quarkus.package.output-name
The name of the final artifact, excluding the suffix and file extension.
Environment variable: QUARKUS_PACKAGE_OUTPUT_NAME
|
string |
|
quarkus.package.write-transformed-bytecode-to-build-output
Setting this switch to true will cause Quarkus to write the transformed application bytecode to the build tool’s output directory. This is useful for post-build tools that need to scan the application bytecode (for example, offline code-coverage tools).
For example, if using Maven, enabling this feature will result in the classes in target/classes being replaced with classes that have been transformed by Quarkus.
Setting this to true , however, should be done with a lot of caution and only if subsequent builds are done in a clean environment (i.e. the build tool’s output directory has been completely cleaned).
Environment variable: QUARKUS_PACKAGE_WRITE_TRANSFORMED_BYTECODE_TO_BUILD_OUTPUT
|
boolean |
false
|
quarkus.package.runner-suffix
The suffix that is applied to the runner artifact’s base file name.
Environment variable: QUARKUS_PACKAGE_RUNNER_SUFFIX
|
string |
-runner
|
The Ide to use to open files from the DevUI. auto means that Quarkus will attempt to determine the Ide being used.
Environment variable: QUARKUS_IDE_TARGET
|
auto , idea , vscode , eclipse , netbeans
|
auto
|
quarkus.configuration.build-time-mismatch-at-runtime
What should happen if the application is started with a different build time configuration than it was compiled against. This may be useful to prevent misconfiguration.
If this is set to warn the application will warn at start up.
If this is set to fail the application will fail at start up.
Native tests leveraging`@io.quarkus.test.junit.TestProfile` are always run with quarkus.configuration.build-time-mismatch-at-runtime = fail .
Environment variable: QUARKUS_CONFIGURATION_BUILD_TIME_MISMATCH_AT_RUNTIME
|
|
warn
|
quarkus.builder.graph-output
Dump the graph output to a file. This is useful for debugging.
Environment variable: QUARKUS_BUILDER_GRAPH_OUTPUT
|
string |
|
quarkus.builder.log-conflict-cause
Whether to log the cause of a conflict.
Environment variable: QUARKUS_BUILDER_LOG_CONFLICT_CAUSE
|
boolean |
|
Environment variable: QUARKUS_DEPLOY_TARGET
|
string |
|
quarkus.test.continuous-testing
If continuous testing is enabled. The default value is 'paused', which will allow you to start testing from the console or the Dev UI, but will not run tests on startup. If this is set to 'enabled' then testing will start as soon as the application has started. If this is 'disabled' then continuous testing is not enabled, and can’t be enabled without restarting the application.
Environment variable: QUARKUS_TEST_CONTINUOUS_TESTING
|
paused , enabled , disabled
|
paused
|
quarkus.test.display-test-output
If output from the running tests should be displayed in the console.
Environment variable: QUARKUS_TEST_DISPLAY_TEST_OUTPUT
|
boolean |
false
|
quarkus.test.include-tags
Tags that should be included for continuous testing. This supports JUnit Tag Expressions.
Environment variable: QUARKUS_TEST_INCLUDE_TAGS
|
list of string |
|
quarkus.test.exclude-tags
Tags that should be excluded by default with continuous testing. This is ignored if include-tags has been set. Defaults to 'slow'. This supports JUnit Tag Expressions.
Environment variable: QUARKUS_TEST_EXCLUDE_TAGS
|
list of string |
slow
|
quarkus.test.include-pattern
Tests that should be included for continuous testing. This is a regular expression and is matched against the test class name (not the file name).
Environment variable: QUARKUS_TEST_INCLUDE_PATTERN
|
string |
|
quarkus.test.exclude-pattern
Tests that should be excluded with continuous testing. This is a regular expression and is matched against the test class name (not the file name). This is ignored if include-pattern has been set.
Environment variable: QUARKUS_TEST_EXCLUDE_PATTERN
|
string |
.*\.IT[^.]+|.*IT|.*ITCase
|
quarkus.test.include-engines
Test engine ids that should be included for continuous testing.
Environment variable: QUARKUS_TEST_INCLUDE_ENGINES
|
list of string |
|
quarkus.test.exclude-engines
Test engine ids that should be excluded by default with continuous testing. This is ignored if include-engines has been set.
Environment variable: QUARKUS_TEST_EXCLUDE_ENGINES
|
list of string |
|
quarkus.test.flat-class-path
Changes tests to use the 'flat' ClassPath used in Quarkus 1.x versions. This means all Quarkus and test classes are loaded in the same ClassLoader, however it means you cannot use continuous testing. Note that if you find this necessary for your application then you may also have problems running in development mode, which cannot use a flat class path.
Environment variable: QUARKUS_TEST_FLAT_CLASS_PATH
|
boolean |
false
|
quarkus.test.native-image-profile
The profile to use when testing the native image
Environment variable: QUARKUS_TEST_NATIVE_IMAGE_PROFILE
|
string |
prod
|
quarkus.test.integration-test-profile
The profile to use when testing using @QuarkusIntegrationTest
Environment variable: QUARKUS_TEST_INTEGRATION_TEST_PROFILE
|
string |
prod
|
A comma separated list of profiles (dev, test, prod or custom profiles) to use when testing using @QuarkusTest
Environment variable: QUARKUS_TEST_PROFILE
|
list of string |
test
|
quarkus.test.profile.tags
The tags this profile is associated with. When the quarkus.test.profile.tags System property is set (its value is a comma separated list of strings) then Quarkus will only execute tests that are annotated with a @TestProfile that has at least one of the supplied (via the aforementioned system property) tags.
Environment variable: QUARKUS_TEST_PROFILE_TAGS
|
list of string |
|
quarkus.test.container.network
Controls the container network to be used when @QuarkusIntegration needs to launch the application in a container. This setting only applies if Quarkus does not need to use a shared network - which is the case if DevServices are used when running the test.
Environment variable: QUARKUS_TEST_CONTAINER_NETWORK
|
string |
|
quarkus.test.container.additional-exposed-ports."host-port"
Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container.
Environment variable: QUARKUS_TEST_CONTAINER_ADDITIONAL_EXPOSED_PORTS__HOST_PORT_
|
Map<String,String> |
|
quarkus.test.container.labels."label-name"
A set of labels to add to the launched container
Environment variable: QUARKUS_TEST_CONTAINER_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.test.container.volume-mounts."host-path"
A set of volume mounts to add to the launched container
Environment variable: QUARKUS_TEST_CONTAINER_VOLUME_MOUNTS__HOST_PATH_
|
Map<String,String> |
|
Additional launch parameters to be used when Quarkus launches the produced artifact for @QuarkusIntegrationTest When the artifact is a jar , this string is passed right after the java command. When the artifact is a container , this string is passed right after the docker run command. When the artifact is a native binary , this string is passed right after the native binary name.
Environment variable: QUARKUS_TEST_ARG_LINE
|
list of string |
|
quarkus.test.env."environment-variable-name"
Additional environment variables to be set in the process that @QuarkusIntegrationTest launches.
Environment variable: QUARKUS_TEST_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Used in @QuarkusIntegrationTest to determine how long the test will wait for the application to launch
Environment variable: QUARKUS_TEST_WAIT_TIME
|
Duration |
PT1M
|
quarkus.test.hang-detection-timeout
Configures the hang detection in @QuarkusTest. If no activity happens (i.e. no test callbacks are called) over this period then QuarkusTest will dump all threads stack traces, to help diagnose a potential hang. Note that the initial timeout (before Quarkus has started) will only apply if provided by a system property, as it is not possible to read all config sources until Quarkus has booted.
Environment variable: QUARKUS_TEST_HANG_DETECTION_TIMEOUT
|
Duration |
10M
|
The type of test to run, this can be either: quarkus-test: Only runs @QuarkusTest annotated test classes unit: Only runs classes that are not annotated with @QuarkusTest all: Runs both, running the unit tests first
Environment variable: QUARKUS_TEST_TYPE
|
|
all
|
quarkus.test.only-test-application-module
If this is true then only the tests from the main application module will be run (i.e. the module that is currently running mvn quarkus:dev). If this is false then tests from all dependency modules will be run as well.
Environment variable: QUARKUS_TEST_ONLY_TEST_APPLICATION_MODULE
|
boolean |
false
|
quarkus.test.include-module-pattern
Modules that should be included for continuous testing. This is a regular expression and is matched against the module groupId:artifactId.
Environment variable: QUARKUS_TEST_INCLUDE_MODULE_PATTERN
|
string |
|
quarkus.test.exclude-module-pattern
Modules that should be excluded for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. This is ignored if include-module-pattern has been set.
Environment variable: QUARKUS_TEST_EXCLUDE_MODULE_PATTERN
|
string |
|
quarkus.test.enable-callbacks-for-integration-tests
If the test callbacks should be invoked for the integration tests (tests annotated with @QuarkusIntegrationTest ).
Environment variable: QUARKUS_TEST_ENABLE_CALLBACKS_FOR_INTEGRATION_TESTS
|
boolean |
false
|
quarkus.execution-model-annotations.detection-mode
Detection mode of invalid usage of execution model annotations.
An execution model annotation is @Blocking , @NonBlocking and @RunOnVirtualThread . These annotations may only be used on "entrypoint" methods (methods invoked by various frameworks in Quarkus); using them on methods that can only be invoked by application code is invalid.
Environment variable: QUARKUS_EXECUTION_MODEL_ANNOTATIONS_DETECTION_MODE
|
|
fail
|
quarkus.analytics.disabled
If Build time analytics are disabled.
Environment variable: QUARKUS_ANALYTICS_DISABLED
|
boolean |
|
quarkus.analytics.uri.base
Environment variable: QUARKUS_ANALYTICS_URI_BASE
|
string |
|
quarkus.analytics.timeout
The Timeout to send the build time analytics to segment.
Environment variable: QUARKUS_ANALYTICS_TIMEOUT
|
int |
3000
|
Enable/Disable SnapStart integration
Default value is dependent on extensions deployed (i.e. when using AWS Lambda extensions, this will be set to true by default)
Environment variable: QUARKUS_SNAPSTART_ENABLE
|
boolean |
|
quarkus.snapstart.preload-classes
Will do a classpath search for all META-INF/quarkus-preload-classes.txt files These files contain fully qualified classnames that should be loaded in the SnapStart/CRaC beforeCheckpoint() phase.
Environment variable: QUARKUS_SNAPSTART_PRELOAD_CLASSES
|
boolean |
true
|
quarkus.snapstart.initialize-classes
if preloading classes, specify whether to do static initialization when preloading these classes.
Environment variable: QUARKUS_SNAPSTART_INITIALIZE_CLASSES
|
boolean |
true
|
quarkus.snapstart.full-warmup
Start the full application during the snapshotting process. In other words, when enabled, it performs Application.start() within SnapStart/CRaC beforeCheckpoint() phase.
Environment variable: QUARKUS_SNAPSTART_FULL_WARMUP
|
boolean |
true
|
quarkus.snapstart.generate-application-class-list
When SnapStart is enabled, it generates the application class list, so it can be preloaded. Only used if preload-classes is set to true .
Environment variable: QUARKUS_SNAPSTART_GENERATE_APPLICATION_CLASS_LIST
|
boolean |
true
|
quarkus.config-tracking.enabled
Whether configuration dumping is enabled
Environment variable: QUARKUS_CONFIG_TRACKING_ENABLED
|
boolean |
false
|
quarkus.config-tracking.directory
Directory in which the configuration dump should be stored. If not configured the .quarkus directory under the project directory will be used.
Environment variable: QUARKUS_CONFIG_TRACKING_DIRECTORY
|
path |
|
quarkus.config-tracking.file
File in which the configuration dump should be stored. If not configured, the file-prefix and file-suffix will be used to generate the final file name. If the configured file path is absolute, the directory option will be ignored. Otherwise, the path will be considered relative to the directory .
Environment variable: QUARKUS_CONFIG_TRACKING_FILE
|
path |
|
quarkus.config-tracking.file-prefix
File name prefix. This option will be ignored in case file is configured.
Environment variable: QUARKUS_CONFIG_TRACKING_FILE_PREFIX
|
string |
quarkus
|
quarkus.config-tracking.file-suffix
File name suffix. This option will be ignored in case file is configured.
Environment variable: QUARKUS_CONFIG_TRACKING_FILE_SUFFIX
|
string |
-config-dump
|
quarkus.config-tracking.exclude
A list of config properties that should be excluded from the report. GLOB patterns could be used instead of property names.
Environment variable: QUARKUS_CONFIG_TRACKING_EXCLUDE
|
list of string |
|
quarkus.config-tracking.hash-options
A list of config properties whose values should be hashed in the report. The values will be hashed using SHA-512 algorithm. GLOB patterns could be used instead of property names.
Environment variable: QUARKUS_CONFIG_TRACKING_HASH_OPTIONS
|
list of string |
|
quarkus.config-tracking.use-user-home-alias-in-paths
Whether to use a ~ as an alias for user home directory in path values
Environment variable: QUARKUS_CONFIG_TRACKING_USE_USER_HOME_ALIAS_IN_PATHS
|
boolean |
true
|
quarkus.log.metrics.enabled
If enabled and a metrics extension is present, logging metrics are published.
Environment variable: QUARKUS_LOG_METRICS_ENABLED
|
boolean |
false
|
The default minimum log level.
Environment variable: QUARKUS_LOG_MIN_LEVEL
|
Level |
DEBUG
|
quarkus.log.decorate-stacktraces
This will decorate the stacktrace in dev mode to show the line in the code that cause the exception
Environment variable: QUARKUS_LOG_DECORATE_STACKTRACES
|
boolean |
true
|
The log level of the root category, which is used as the default log level for all categories.
JBoss Logging supports Apache-style log levels:
-
{@link org.jboss.logmanager.Level#FATAL}
-
{@link org.jboss.logmanager.Level#ERROR}
-
{@link org.jboss.logmanager.Level#WARN}
-
{@link org.jboss.logmanager.Level#INFO}
-
{@link org.jboss.logmanager.Level#DEBUG}
-
{@link org.jboss.logmanager.Level#TRACE}
In addition, it also supports the standard JDK log levels.
Environment variable: QUARKUS_LOG_LEVEL
|
Level |
INFO
|
The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers.
Environment variable: QUARKUS_LOG_HANDLERS
|
list of string |
|
Minimum logging categories |
Type |
Default |
quarkus.log.category."categories".min-level
The minimum log level for this category. By default, all categories are configured with DEBUG minimum level.
To get runtime logging below DEBUG , e.g., TRACE , adjust the minimum level at build time. The right log level needs to be provided at runtime.
As an example, to get TRACE logging, minimum level needs to be at TRACE , and the runtime log level needs to match that.
Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL
|
InheritableLevel |
inherit
|
quarkus.log.category."categories".level
The log level for this category.
Note that to get log levels below INFO , the minimum level build-time configuration option also needs to be adjusted.
Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL
|
InheritableLevel |
inherit
|
quarkus.log.category."categories".handlers
The names of the handlers to link to this category.
Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS
|
list of string |
|
quarkus.log.category."categories".use-parent-handlers
Specify whether this logger should send its output to its parent Logger
Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS
|
boolean |
true
|
Console logging |
Type |
Default |
quarkus.log.console.enable
If console logging should be enabled
Environment variable: QUARKUS_LOG_CONSOLE_ENABLE
|
boolean |
true
|
quarkus.log.console.stderr
If console logging should go to System#err instead of System#out .
Environment variable: QUARKUS_LOG_CONSOLE_STDERR
|
boolean |
false
|
quarkus.log.console.format
The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).
Environment variable: QUARKUS_LOG_CONSOLE_FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n
|
quarkus.log.console.level
Environment variable: QUARKUS_LOG_CONSOLE_LEVEL
|
Level |
ALL
|
quarkus.log.console.darken
Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).
Environment variable: QUARKUS_LOG_CONSOLE_DARKEN
|
int |
0
|
quarkus.log.console.filter
The name of the filter to link to the console handler.
Environment variable: QUARKUS_LOG_CONSOLE_FILTER
|
string |
|
quarkus.log.console.async
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_CONSOLE_ASYNC
|
boolean |
false
|
quarkus.log.console.async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.console.async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW
|
|
block
|
File logging |
Type |
Default |
If file logging should be enabled
Environment variable: QUARKUS_LOG_FILE_ENABLE
|
boolean |
false
|
Environment variable: QUARKUS_LOG_FILE_FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n
|
The level of logs to be written into the file.
Environment variable: QUARKUS_LOG_FILE_LEVEL
|
Level |
ALL
|
The name of the file in which logs will be written.
Environment variable: QUARKUS_LOG_FILE_PATH
|
File |
quarkus.log
|
The name of the filter to link to the file handler.
Environment variable: QUARKUS_LOG_FILE_FILTER
|
string |
|
quarkus.log.file.encoding
The character encoding used
Environment variable: QUARKUS_LOG_FILE_ENCODING
|
Charset |
|
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_FILE_ASYNC
|
boolean |
false
|
quarkus.log.file.async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.file.async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_FILE_ASYNC_OVERFLOW
|
|
block
|
quarkus.log.file.rotation.max-file-size
The maximum log file size, after which a rotation is executed.
Environment variable: QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE
|
MemorySize |
10M
|
quarkus.log.file.rotation.max-backup-index
The maximum number of backups to keep.
Environment variable: QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX
|
int |
5
|
quarkus.log.file.rotation.file-suffix
The file handler rotation file suffix. When used, the file will be rotated based on its suffix.
The suffix must be in a date-time format that is understood by DateTimeFormatter .
Example fileSuffix: .yyyy-MM-dd
Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed.
Environment variable: QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX
|
string |
|
quarkus.log.file.rotation.rotate-on-boot
Indicates whether to rotate log files on server initialization.
You need to either set a max-file-size or configure a file-suffix for it to work.
Environment variable: QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT
|
boolean |
true
|
Syslog logging |
Type |
Default |
quarkus.log.syslog.enable
If syslog logging should be enabled
Environment variable: QUARKUS_LOG_SYSLOG_ENABLE
|
boolean |
false
|
quarkus.log.syslog.endpoint
The IP address and port of the Syslog server
Environment variable: QUARKUS_LOG_SYSLOG_ENDPOINT
|
host:port |
localhost:514
|
quarkus.log.syslog.app-name
The app name used when formatting the message in RFC5424 format
Environment variable: QUARKUS_LOG_SYSLOG_APP_NAME
|
string |
|
quarkus.log.syslog.hostname
The name of the host the messages are being sent from
Environment variable: QUARKUS_LOG_SYSLOG_HOSTNAME
|
string |
|
quarkus.log.syslog.facility
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164
Environment variable: QUARKUS_LOG_SYSLOG_FACILITY
|
kernel , user-level , mail-system , system-daemons , security , syslogd , line-printer , network-news , uucp , clock-daemon , security2 , ftp-daemon , ntp , log-audit , log-alert , clock-daemon2 , local-use-0 , local-use-1 , local-use-2 , local-use-3 , local-use-4 , local-use-5 , local-use-6 , local-use-7
|
user-level
|
quarkus.log.syslog.syslog-type
Set the SyslogType syslog type this handler should use to format the message sent
Environment variable: QUARKUS_LOG_SYSLOG_SYSLOG_TYPE
|
|
rfc5424
|
quarkus.log.syslog.protocol
Sets the protocol used to connect to the Syslog server
Environment variable: QUARKUS_LOG_SYSLOG_PROTOCOL
|
|
tcp
|
quarkus.log.syslog.use-counting-framing
If enabled, the message being sent is prefixed with the size of the message
Environment variable: QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING
|
boolean |
false
|
quarkus.log.syslog.truncate
Set to true to truncate the message if it exceeds maximum length
Environment variable: QUARKUS_LOG_SYSLOG_TRUNCATE
|
boolean |
true
|
quarkus.log.syslog.block-on-reconnect
Enables or disables blocking when attempting to reconnect a org.jboss.logmanager.handlers.SyslogHandler.Protocol#TCP
TCP or org.jboss.logmanager.handlers.SyslogHandler.Protocol#SSL_TCP SSL TCP protocol
Environment variable: QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT
|
boolean |
false
|
quarkus.log.syslog.format
Environment variable: QUARKUS_LOG_SYSLOG_FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n
|
The log level specifying what message levels will be logged by the Syslog logger
Environment variable: QUARKUS_LOG_SYSLOG_LEVEL
|
Level |
ALL
|
quarkus.log.syslog.filter
The name of the filter to link to the file handler.
Environment variable: QUARKUS_LOG_SYSLOG_FILTER
|
string |
|
quarkus.log.syslog.max-length
The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message.
If not set, the default value is 2048 when sys-log-type is rfc5424 (which is the default) and 1024 when sys-log-type is rfc3164
Environment variable: QUARKUS_LOG_SYSLOG_MAX_LENGTH
|
MemorySize |
|
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_SYSLOG_ASYNC
|
boolean |
false
|
quarkus.log.syslog.async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.syslog.async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW
|
|
block
|
Console handlers |
Type |
Default |
quarkus.log.handler.console."console-handlers".enable
If console logging should be enabled
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE
|
boolean |
true
|
quarkus.log.handler.console."console-handlers".stderr
If console logging should go to System#err instead of System#out .
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR
|
boolean |
false
|
quarkus.log.handler.console."console-handlers".format
The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n
|
quarkus.log.handler.console."console-handlers".level
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL
|
Level |
ALL
|
quarkus.log.handler.console."console-handlers".darken
Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN
|
int |
0
|
quarkus.log.handler.console."console-handlers".filter
The name of the filter to link to the console handler.
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER
|
string |
|
quarkus.log.handler.console."console-handlers".async
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC
|
boolean |
false
|
quarkus.log.handler.console."console-handlers".async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.handler.console."console-handlers".async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW
|
|
block
|
File handlers |
Type |
Default |
quarkus.log.handler.file."file-handlers".enable
If file logging should be enabled
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE
|
boolean |
false
|
quarkus.log.handler.file."file-handlers".format
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n
|
quarkus.log.handler.file."file-handlers".level
The level of logs to be written into the file.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL
|
Level |
ALL
|
quarkus.log.handler.file."file-handlers".path
The name of the file in which logs will be written.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH
|
File |
quarkus.log
|
quarkus.log.handler.file."file-handlers".filter
The name of the filter to link to the file handler.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER
|
string |
|
quarkus.log.handler.file."file-handlers".encoding
The character encoding used
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING
|
Charset |
|
quarkus.log.handler.file."file-handlers".async
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC
|
boolean |
false
|
quarkus.log.handler.file."file-handlers".async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.handler.file."file-handlers".async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW
|
|
block
|
quarkus.log.handler.file."file-handlers".rotation.max-file-size
The maximum log file size, after which a rotation is executed.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE
|
MemorySize |
10M
|
quarkus.log.handler.file."file-handlers".rotation.max-backup-index
The maximum number of backups to keep.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX
|
int |
5
|
quarkus.log.handler.file."file-handlers".rotation.file-suffix
The file handler rotation file suffix. When used, the file will be rotated based on its suffix.
The suffix must be in a date-time format that is understood by DateTimeFormatter .
Example fileSuffix: .yyyy-MM-dd
Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX
|
string |
|
quarkus.log.handler.file."file-handlers".rotation.rotate-on-boot
Indicates whether to rotate log files on server initialization.
You need to either set a max-file-size or configure a file-suffix for it to work.
Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT
|
boolean |
true
|
Syslog handlers |
Type |
Default |
quarkus.log.handler.syslog."syslog-handlers".enable
If syslog logging should be enabled
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE
|
boolean |
false
|
quarkus.log.handler.syslog."syslog-handlers".endpoint
The IP address and port of the Syslog server
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT
|
host:port |
localhost:514
|
quarkus.log.handler.syslog."syslog-handlers".app-name
The app name used when formatting the message in RFC5424 format
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME
|
string |
|
quarkus.log.handler.syslog."syslog-handlers".hostname
The name of the host the messages are being sent from
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME
|
string |
|
quarkus.log.handler.syslog."syslog-handlers".facility
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY
|
kernel , user-level , mail-system , system-daemons , security , syslogd , line-printer , network-news , uucp , clock-daemon , security2 , ftp-daemon , ntp , log-audit , log-alert , clock-daemon2 , local-use-0 , local-use-1 , local-use-2 , local-use-3 , local-use-4 , local-use-5 , local-use-6 , local-use-7
|
user-level
|
quarkus.log.handler.syslog."syslog-handlers".syslog-type
Set the SyslogType syslog type this handler should use to format the message sent
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE
|
|
rfc5424
|
quarkus.log.handler.syslog."syslog-handlers".protocol
Sets the protocol used to connect to the Syslog server
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL
|
|
tcp
|
quarkus.log.handler.syslog."syslog-handlers".use-counting-framing
If enabled, the message being sent is prefixed with the size of the message
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING
|
boolean |
false
|
quarkus.log.handler.syslog."syslog-handlers".truncate
Set to true to truncate the message if it exceeds maximum length
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE
|
boolean |
true
|
quarkus.log.handler.syslog."syslog-handlers".block-on-reconnect
Enables or disables blocking when attempting to reconnect a org.jboss.logmanager.handlers.SyslogHandler.Protocol#TCP
TCP or org.jboss.logmanager.handlers.SyslogHandler.Protocol#SSL_TCP SSL TCP protocol
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT
|
boolean |
false
|
quarkus.log.handler.syslog."syslog-handlers".format
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT
|
string |
%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c{3.}] (%t) %s%e%n
|
quarkus.log.handler.syslog."syslog-handlers".level
The log level specifying what message levels will be logged by the Syslog logger
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL
|
Level |
ALL
|
quarkus.log.handler.syslog."syslog-handlers".filter
The name of the filter to link to the file handler.
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER
|
string |
|
quarkus.log.handler.syslog."syslog-handlers".max-length
The maximum length, in bytes, of the message allowed to be sent. The length includes the header and the message.
If not set, the default value is 2048 when sys-log-type is rfc5424 (which is the default) and 1024 when sys-log-type is rfc3164
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH
|
MemorySize |
|
quarkus.log.handler.syslog."syslog-handlers".async
Indicates whether to log asynchronously
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC
|
boolean |
false
|
quarkus.log.handler.syslog."syslog-handlers".async.queue-length
The queue length to use before flushing writing
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH
|
int |
512
|
quarkus.log.handler.syslog."syslog-handlers".async.overflow
Determine whether to block the publisher (rather than drop the message) when the queue is full
Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW
|
|
block
|
Log cleanup filters - internal use |
Type |
Default |
quarkus.log.filter."filters".if-starts-with
The message prefix to match
Environment variable: QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH
|
list of string |
inherit
|
quarkus.log.filter."filters".target-level
The new log level for the filtered message. Defaults to DEBUG.
Environment variable: QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL
|
Level |
DEBUG
|
quarkus.class-loading.parent-first-artifacts
Artifacts that are loaded in a parent first manner. This can be used to work around issues where a given class needs to be loaded by the system ClassLoader. Note that if you make a library parent first all its dependencies should generally also be parent first.
Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon.
|
This config property can only be set in application.properties
|
Environment variable: QUARKUS_CLASS_LOADING_PARENT_FIRST_ARTIFACTS
|
list of string |
|
quarkus.class-loading.reloadable-artifacts
Artifacts that are loaded in the runtime ClassLoader in dev mode, so they will be dropped and recreated on change.
This is an advanced option, it should only be used if you have a problem with libraries holding stale state between reloads. Note that if you use this any library that depends on the listed libraries will also need to be reloadable.
This setting has no impact on production builds.
Artifacts should be configured as a comma separated list of artifact ids, with the group, artifact-id and optional classifier separated by a colon.
|
This config property can only be set in application.properties
|
Environment variable: QUARKUS_CLASS_LOADING_RELOADABLE_ARTIFACTS
|
string |
|
quarkus.class-loading.removed-artifacts
Artifacts that will never be loaded by the class loader, and will not be packed into the final application. This allows you to explicitly remove artifacts from your application even though they may be present on the class path.
Environment variable: QUARKUS_CLASS_LOADING_REMOVED_ARTIFACTS
|
list of string |
|
quarkus.class-loading.removed-resources."group-id:artifact-id"
Resources that should be removed/hidden from dependencies.
This allows for classes and other resources to be removed from dependencies, so they are not accessible to the application. This is a map of artifact id (in the form group:artifact) to a list of resources to be removed.
When running in dev and test mode these resources are hidden from the ClassLoader, when running in production mode these files are removed from the jars that contain them.
Note that if you want to remove a class you need to specify the class file name. e.g. to remove com.acme.Foo you would specify com/acme/Foo.class .
Note that for technical reasons this is not supported when running with JBang.
Environment variable: QUARKUS_CLASS_LOADING_REMOVED_RESOURCES__GROUP_ID_ARTIFACT_ID_
|
list of Map<String,Set<String>> |
|
A comma separated list of profiles that will be active when Quarkus launches.
Environment variable: QUARKUS_PROFILE
|
list of string |
|
quarkus.config.profile.parent
Accepts a single configuration profile name. If a configuration property cannot be found in the current active profile, the config performs the same lookup in the profile set by this configuration.
Environment variable: QUARKUS_CONFIG_PROFILE_PARENT
|
string |
|
Additional config locations to be loaded with the Config. The configuration support multiple locations separated by a comma and each must represent a valid java.net.URI .
Environment variable: QUARKUS_CONFIG_LOCATIONS
|
list of URI |
|
quarkus.config.mapping.validate-unknown
Validates that a @ConfigMapping maps every available configuration name contained in the mapping prefix.
Environment variable: QUARKUS_CONFIG_MAPPING_VALIDATE_UNKNOWN
|
boolean |
|
quarkus.config.log.values
Enable logging of configuration values lookup in DEBUG log level.
The log of configuration values require the category set to DEBUG in the io.smallrye.config category: quarkus.log.category."io.smallrye.config".level=DEBUG .
Environment variable: QUARKUS_CONFIG_LOG_VALUES
|
boolean |
|
A property that allows accessing a generated UUID. It generates that UUID at startup time. So it changes between two starts including in dev mode.
Access this generated UUID using expressions: ${quarkus.uuid} .
Environment variable: QUARKUS_UUID
|
string |
|
quarkus.shutdown.delay-enabled
Whether Quarkus should wait between shutdown being requested and actually initiated. This delay gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it.
Environment variable: QUARKUS_SHUTDOWN_DELAY_ENABLED
|
boolean |
false
|
The timeout to wait for running requests to finish. If this is not set then the application will exit immediately. Setting this timeout will incur a small performance penalty, as it requires active requests to be tracked.
Environment variable: QUARKUS_SHUTDOWN_TIMEOUT
|
Duration |
|
Delay between shutdown being requested and actually initiated. Also called the pre-shutdown phase. In pre-shutdown, the server continues working as usual, except a readiness probe starts reporting "down" (if the smallrye-health extension is present). This gives the infrastructure time to detect that the application instance is shutting down and stop routing traffic to it. Notice that this property will only take effect if quarkus.shutdown.delay-enabled is explicitly set to true .
Environment variable: QUARKUS_SHUTDOWN_DELAY
|
Duration |
|
The path of the banner (path relative to root of classpath) which could be provided by user
Environment variable: QUARKUS_BANNER_PATH
|
string |
default_banner.txt
|
Whether the banner will be displayed
Environment variable: QUARKUS_BANNER_ENABLED
|
boolean |
true
|
Enable native SSL support.
Environment variable: QUARKUS_SSL_NATIVE
|
boolean |
|
If test results and status should be displayed in the console.
If this is false results can still be viewed in the dev console.
Environment variable: QUARKUS_CONSOLE_ENABLED
|
boolean |
true
|
quarkus.console.disable-input
Disables the ability to enter input on the console.
Environment variable: QUARKUS_CONSOLE_DISABLE_INPUT
|
boolean |
false
|
Disable the testing status/prompt message at the bottom of the console and log these messages to STDOUT instead.
Use this option if your terminal does not support ANSI escape sequences.
Environment variable: QUARKUS_CONSOLE_BASIC
|
boolean |
false
|
If color should be enabled or disabled. If this is not present then an attempt will be made to guess if the terminal supports color
Environment variable: QUARKUS_CONSOLE_COLOR
|
boolean |
|
If set to true, writes a list of all reflective classes to META-INF
Environment variable: QUARKUS_DEBUG_REFLECTION
|
boolean |
false
|
quarkus.debug.generated-classes-dir
If set to a directory, all generated classes will be written into that directory
Environment variable: QUARKUS_DEBUG_GENERATED_CLASSES_DIR
|
string |
|
quarkus.debug.transformed-classes-dir
If set to a directory, all transformed classes (e.g. Panache entities) will be written into that directory
Environment variable: QUARKUS_DEBUG_TRANSFORMED_CLASSES_DIR
|
string |
|
quarkus.debug.generated-sources-dir
If set to a directory, ZIG files for generated code will be written into that directory.
A ZIG file is a textual representation of the generated code that is referenced in the stacktraces.
Environment variable: QUARKUS_DEBUG_GENERATED_SOURCES_DIR
|
string |
|
quarkus.debug.dump-build-metrics
If set to true then dump the build metrics to a JSON file in the build directory.
Environment variable: QUARKUS_DEBUG_DUMP_BUILD_METRICS
|
boolean |
false
|
quarkus.debug.print-startup-times
If set to true , Quarkus prints the wall-clock time each build step took to complete. This is useful as a first step in debugging slow startup times.
Environment variable: QUARKUS_DEBUG_PRINT_STARTUP_TIMES
|
boolean |
false
|
Datasources |
Type |
Default |
quarkus.datasource.health.enabled
Whether or not a health check is published in case the smallrye-health extension is present.
This is a global setting and is not specific to a datasource.
Environment variable: QUARKUS_DATASOURCE_HEALTH_ENABLED
|
boolean |
true
|
quarkus.datasource.metrics.enabled
Whether or not datasource metrics are published in case a metrics extension is present.
This is a global setting and is not specific to a datasource.
|
This is different from the "jdbc.enable-metrics" property that needs to be set on the JDBC datasource level to enable collection of metrics for that datasource.
|
Environment variable: QUARKUS_DATASOURCE_METRICS_ENABLED
|
boolean |
false
|
quarkus.datasource.db-kind
quarkus.datasource."datasource-name".db-kind
The kind of database we will connect to (e.g. h2, postgresql…).
Environment variable: QUARKUS_DATASOURCE_DB_KIND
|
string |
|
quarkus.datasource.db-version
quarkus.datasource."datasource-name".db-version
The version of the database we will connect to (e.g. '10.0').
|
The version number set here should follow the same numbering scheme
as the string returned by java.sql.DatabaseMetaData#getDatabaseProductVersion()
for your database’s JDBC driver.
This numbering scheme may be different from the most popular one for your database;
for example Microsoft SQL Server 2016 would be version 13 .
|
As a rule, the version set here should be as high as possible,
but must be lower than or equal to the version of any database your application will connect to.
A high version will allow better performance and using more features
(e.g. Hibernate ORM may generate more efficient SQL,
avoid workarounds and take advantage of more database features),
but if it is higher than the version of the database you want to connect to,
it may lead to runtime exceptions
(e.g. Hibernate ORM may generate invalid SQL that your database will reject).
Some extensions (like the Hibernate ORM extension)
will try to check this version against the actual database version on startup,
leading to a startup failure when the actual version is lower
or simply a warning in case the database cannot be reached.
The default for this property is specific to each extension;
the Hibernate ORM extension will default to the oldest version it supports.
Environment variable: QUARKUS_DATASOURCE_DB_VERSION
|
string |
|
quarkus.datasource.health-exclude
quarkus.datasource."datasource-name".health-exclude
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.
By default, the health check includes all configured data sources (if it is enabled).
Environment variable: QUARKUS_DATASOURCE_HEALTH_EXCLUDE
|
boolean |
false
|
quarkus.datasource.active
quarkus.datasource."datasource-name".active
Whether this datasource should be active at runtime.
If the datasource is not active, it won’t start with the application,
and accessing the corresponding Datasource CDI bean will fail,
meaning in particular that consumers of this datasource
(e.g. Hibernate ORM persistence units) will fail to start unless they are inactive too.
Environment variable: QUARKUS_DATASOURCE_ACTIVE
|
boolean |
true
|
quarkus.datasource.username
quarkus.datasource."datasource-name".username
Environment variable: QUARKUS_DATASOURCE_USERNAME
|
string |
|
quarkus.datasource.password
quarkus.datasource."datasource-name".password
Environment variable: QUARKUS_DATASOURCE_PASSWORD
|
string |
|
quarkus.datasource.credentials-provider
quarkus.datasource."datasource-name".credentials-provider
The credentials provider name
Environment variable: QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER
|
string |
|
quarkus.datasource.credentials-provider-name
quarkus.datasource."datasource-name".credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_DATASOURCE_CREDENTIALS_PROVIDER_NAME
|
string |
|
Dev Services |
Type |
Default |
quarkus.datasource.devservices.enabled
quarkus.datasource."datasource-name".devservices.enabled
Whether this Dev Service should start with the application in dev mode or tests.
Dev Services are enabled by default
unless connection configuration (e.g. the JDBC URL or reactive client URL) is set explicitly.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.datasource.devservices.image-name
quarkus.datasource."datasource-name".devservices.image-name
The container image name for container-based Dev Service providers.
This has no effect if the provider is not a container-based database, such as H2 or Derby.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.datasource.devservices.container-env."environment-variable-name"
quarkus.datasource."datasource-name".devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.datasource.devservices.container-properties."property-key"
quarkus.datasource."datasource-name".devservices.container-properties."property-key"
Generic properties that are passed for additional container configuration.
Properties defined here are database-specific and are interpreted specifically in each database dev service implementation.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_CONTAINER_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.datasource.devservices.properties."property-key"
quarkus.datasource."datasource-name".devservices.properties."property-key"
Generic properties that are added to the database connection URL.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.datasource.devservices.port
quarkus.datasource."datasource-name".devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PORT
|
int |
|
quarkus.datasource.devservices.command
quarkus.datasource."datasource-name".devservices.command
The container start command to use for container-based Dev Service providers.
This has no effect if the provider is not a container-based database, such as H2 or Derby.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_COMMAND
|
string |
|
quarkus.datasource.devservices.db-name
quarkus.datasource."datasource-name".devservices.db-name
The database name to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_DB_NAME
|
string |
|
quarkus.datasource.devservices.username
quarkus.datasource."datasource-name".devservices.username
The username to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_USERNAME
|
string |
|
quarkus.datasource.devservices.password
quarkus.datasource."datasource-name".devservices.password
The password to use if this Dev Service supports overriding it.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_PASSWORD
|
string |
|
quarkus.datasource.devservices.init-script-path
quarkus.datasource."datasource-name".devservices.init-script-path
The path to a SQL script to be loaded from the classpath and applied to the Dev Service database.
This has no effect if the provider is not a container-based database, such as H2 or Derby.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_INIT_SCRIPT_PATH
|
string |
|
quarkus.datasource.devservices.volumes."host-path"
quarkus.datasource."datasource-name".devservices.volumes."host-path"
The volumes to be mapped to the container.
The map key corresponds to the host location; the map value is the container location. If the host location starts with "classpath:", the mapping loads the resource from the classpath with read-only permission.
When using a file system location, the volume will be generated with read-write permission, potentially leading to data loss or modification in your file system.
This has no effect if the provider is not a container-based database, such as H2 or Derby.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_VOLUMES__HOST_PATH_
|
Map<String,String> |
|
quarkus.datasource.devservices.reuse
quarkus.datasource."datasource-name".devservices.reuse
Whether to keep Dev Service containers running after a dev mode session or test suite execution
to reuse them in the next dev mode session or test suite execution.
Within a dev mode session or test suite execution,
Quarkus will always reuse Dev Services as long as their configuration
(username, password, environment, port bindings, …) did not change.
This feature is specifically about keeping containers running
when Quarkus is not running to reuse them across runs.
|
This feature needs to be enabled explicitly in testcontainers.properties ,
may require changes to how you configure data initialization in dev mode and tests,
and may leave containers running indefinitely, forcing you to stop and remove them manually.
See this section of the documentation for more information.
|
This configuration property is set to true by default,
so it is mostly useful to disable reuse,
if you enabled it in testcontainers.properties
but only want to use it for some of your Quarkus applications or datasources.
Environment variable: QUARKUS_DATASOURCE_DEVSERVICES_REUSE
|
boolean |
true
|
Eclipse Vert.x - HTTP |
Type |
Default |
The HTTP root path. All web content will be served relative to this root path.
Environment variable: QUARKUS_HTTP_ROOT_PATH
|
string |
/
|
If basic auth should be enabled. If both basic and form auth is enabled then basic auth will be enabled in silent mode. The basic auth is enabled by default if no authentication mechanisms are configured or Quarkus can safely determine that basic authentication is required.
Environment variable: QUARKUS_HTTP_AUTH_BASIC
|
boolean |
|
quarkus.http.auth.form.enabled
If form authentication is enabled.
Environment variable: QUARKUS_HTTP_AUTH_FORM_ENABLED
|
boolean |
false
|
quarkus.http.auth.form.post-location
Environment variable: QUARKUS_HTTP_AUTH_FORM_POST_LOCATION
|
string |
/j_security_check
|
quarkus.http.auth.proactive
If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.
Environment variable: QUARKUS_HTTP_AUTH_PROACTIVE
|
boolean |
true
|
quarkus.http.ssl.client-auth
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED .
When set to REQUIRED , it’s recommended to also set quarkus.http.insecure-requests=disabled to disable the plain HTTP port. If quarkus.http.insecure-requests is not set, but this parameter is set to REQUIRED , then, quarkus.http.insecure-requests is automatically set to disabled .
Environment variable: QUARKUS_HTTP_SSL_CLIENT_AUTH
|
|
none
|
If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes.
Environment variable: QUARKUS_HTTP_VIRTUAL
|
boolean |
false
|
quarkus.http.non-application-root-path
A common root path for non-application endpoints. Various extension-provided endpoints such as metrics, health,
and openapi are deployed under this path by default.
<p>
* Relative path (Default, q ) →
Non-application endpoints will be served from
${quarkus.http.root-path}/${quarkus.http.non-application-root-path} .
* Absolute path (/q ) →
Non-application endpoints will be served from the specified path.
* ${quarkus.http.root-path} → Setting this path to the same value as HTTP root path disables
this root path. All extension-provided endpoints will be served from ${quarkus.http.root-path} .
<p>
If the management interface is enabled, the root path for the endpoints exposed on the management interface
is configured using the quarkus.management.root-path property instead of this property.
Environment variable: QUARKUS_HTTP_NON_APPLICATION_ROOT_PATH
|
string |
q
|
quarkus.http.test-timeout
The REST Assured client timeout for testing.
Environment variable: QUARKUS_HTTP_TEST_TIMEOUT
|
Duration |
30S
|
quarkus.http.enable-compression
If enabled then the response body is compressed if the Content-Type header is set and the value is a compressed media type as configured via compress-media-types .
Note that the RESTEasy Reactive and Reactive Routes extensions also make it possible to enable/disable compression declaratively using the annotations io.quarkus.vertx.http.Compressed and io.quarkus.vertx.http.Uncompressed .
Environment variable: QUARKUS_HTTP_ENABLE_COMPRESSION
|
boolean |
false
|
quarkus.http.enable-decompression
When enabled, vert.x will decompress the request’s body if it’s compressed.
Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
Environment variable: QUARKUS_HTTP_ENABLE_DECOMPRESSION
|
boolean |
false
|
If user adds br, then brotli will be added to the list of supported compression algorithms. It implies loading libbrotli native library via JNI and in case of native image, packing the native library into the native image as a resource thus inflating its size. Note that a native shared object library must be available for your platform in Brotli4J project.
Client expresses its capability by sending Accept-Encoding header, e.g. Accept-Encoding: deflate, gzip, br Server chooses the compression algorithm based on the client’s capabilities and marks it in a response header, e.g.: content-encoding: gzip
Environment variable: QUARKUS_HTTP_COMPRESSORS
|
list of string |
gzip,deflate
|
quarkus.http.compress-media-types
List of media types for which the compression should be enabled automatically, unless declared explicitly via Compressed or Uncompressed .
Environment variable: QUARKUS_HTTP_COMPRESS_MEDIA_TYPES
|
list of string |
text/html,text/plain,text/xml,text/css,text/javascript,application/javascript,application/graphql+json
|
quarkus.http.compression-level
The compression level used when compression support is enabled.
Environment variable: QUARKUS_HTTP_COMPRESSION_LEVEL
|
int |
|
Environment variable: QUARKUS_HTTP_CORS
|
boolean |
false
|
Environment variable: QUARKUS_HTTP_PORT
|
int |
8080
|
The HTTP port used to run tests
Environment variable: QUARKUS_HTTP_TEST_PORT
|
int |
8081
|
In dev/test mode this defaults to localhost, in prod mode this defaults to 0.0.0.0
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
As an exception, when running in Windows Subsystem for Linux (WSL), the HTTP host defaults to 0.0.0.0 even in dev/test mode since using localhost makes the application inaccessible.
Environment variable: QUARKUS_HTTP_HOST
|
string |
required |
Used when QuarkusIntegrationTest is meant to execute against an application that is already running and listening on the host specified by this property.
Environment variable: QUARKUS_HTTP_TEST_HOST
|
string |
|
quarkus.http.host-enabled
Enable listening to host:port
Environment variable: QUARKUS_HTTP_HOST_ENABLED
|
boolean |
true
|
Environment variable: QUARKUS_HTTP_SSL_PORT
|
int |
8443
|
quarkus.http.test-ssl-port
The HTTPS port used to run tests
Environment variable: QUARKUS_HTTP_TEST_SSL_PORT
|
int |
8444
|
quarkus.http.test-ssl-enabled
Used when QuarkusIntegrationTest is meant to execute against an application that is already running to configure the test to use SSL.
Environment variable: QUARKUS_HTTP_TEST_SSL_ENABLED
|
boolean |
|
quarkus.http.insecure-requests
If insecure (i.e. http rather than https) requests are allowed. If this is enabled then http works as normal. redirect will still open the http port, but all requests will be redirected to the HTTPS port. disabled will prevent the HTTP port from opening at all.
Default is enabled except when client auth is set to required (configured using quarkus.http.ssl.client-auth=required ). In this case, the default is disabled .
Environment variable: QUARKUS_HTTP_INSECURE_REQUESTS
|
enabled , redirect , disabled
|
|
If this is true (the default) then HTTP/2 will be enabled.
Note that for browsers to be able to use it HTTPS must be enabled, and you must be running on JDK11 or above, as JDK8 does not support ALPN.
Environment variable: QUARKUS_HTTP_HTTP2
|
boolean |
true
|
quarkus.http.http2-push-enabled
Enables or Disable the HTTP/2 Push feature. This setting can be used to disable server push. The server will not send a PUSH_PROMISE frame if it receives this parameter set to @{code false}.
Environment variable: QUARKUS_HTTP_HTTP2_PUSH_ENABLED
|
boolean |
true
|
quarkus.http.ssl.certificate.credentials-provider
The CredentialsProvider . If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.
Please note that using MicroProfile ConfigSource which is directly supported by Quarkus Configuration should be preferred unless using CredentialsProvider provides for some additional security and dynamism.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER
|
string |
|
quarkus.http.ssl.certificate.credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.http.ssl.certificate.files
The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_FILES
|
list of path |
|
quarkus.http.ssl.certificate.key-files
The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.
The order of the key files must match the order of the certificates.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_FILES
|
list of path |
|
quarkus.http.ssl.certificate.key-store-file
An optional keystore that holds the certificate information instead of specifying separate files.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE
|
path |
|
quarkus.http.ssl.certificate.key-store-file-type
An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE
|
string |
|
quarkus.http.ssl.certificate.key-store-provider
An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PROVIDER
|
string |
|
quarkus.http.ssl.certificate.key-store-password
A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD
|
string |
password
|
quarkus.http.ssl.certificate.key-store-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the key store file from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY
|
string |
|
quarkus.http.ssl.certificate.key-store-alias
An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS
|
string |
|
quarkus.http.ssl.certificate.key-store-alias-password
An optional parameter to define the password for the key, in case it is different from key-store-password If not given, it might be retrieved from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD
|
string |
|
quarkus.http.ssl.certificate.key-store-alias-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password for the alias from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY
|
string |
|
quarkus.http.ssl.certificate.trust-store-file
An optional trust store that holds the certificate information of the trusted certificates.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE
|
path |
|
quarkus.http.ssl.certificate.trust-store-files
An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILES
|
list of path |
|
quarkus.http.ssl.certificate.trust-store-file-type
An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE
|
string |
|
quarkus.http.ssl.certificate.trust-store-provider
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PROVIDER
|
string |
|
quarkus.http.ssl.certificate.trust-store-password
A parameter to specify the password of the trust store file. If not given, it might be retrieved from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD
|
string |
|
quarkus.http.ssl.certificate.trust-store-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the trust store file from CredentialsProvider .
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY
|
string |
|
quarkus.http.ssl.certificate.trust-store-cert-alias
An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS
|
string |
|
quarkus.http.ssl.certificate.reload-period
When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.
Also, the update can also occur when the TLS certificate is configured using paths (and not in-memory).
The reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.
|
It’s recommended to use the TLS registry to handle the certificate reloading.
|
Environment variable: QUARKUS_HTTP_SSL_CERTIFICATE_RELOAD_PERIOD
|
Duration |
|
quarkus.http.ssl.cipher-suites
The cipher suites to use. If none is given, a reasonable default is selected.
Environment variable: QUARKUS_HTTP_SSL_CIPHER_SUITES
|
list of string |
|
quarkus.http.ssl.protocols
Sets the ordered list of enabled SSL/TLS protocols.
If not set, it defaults to "TLSv1.3, TLSv1.2" . The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 . To only enable TLSv1.3 , set the value to to "TLSv1.3" .
Note that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.
Environment variable: QUARKUS_HTTP_SSL_PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.
Environment variable: QUARKUS_HTTP_SSL_SNI
|
boolean |
false
|
quarkus.http.tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration is set, and quarkus.tls.* is not configured, then, quarkus.http.ssl will be used.
Environment variable: QUARKUS_HTTP_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.http.handle-100-continue-automatically
When set to true , the HTTP server automatically sends 100 CONTINUE response when the request expects it (with the Expect: 100-Continue header).
Environment variable: QUARKUS_HTTP_HANDLE_100_CONTINUE_AUTOMATICALLY
|
boolean |
false
|
The number if IO threads used to perform IO. This will be automatically set to a reasonable value based on the number of CPU cores if it is not provided. If this is set to a higher value than the number of Vert.x event loops then it will be capped at the number of event loops.
In general this should be controlled by setting quarkus.vertx.event-loops-pool-size, this setting should only be used if you want to limit the number of HTTP io threads to a smaller number than the total number of IO threads.
Environment variable: QUARKUS_HTTP_IO_THREADS
|
int |
|
quarkus.http.idle-timeout
Http connection idle timeout
Environment variable: QUARKUS_HTTP_IDLE_TIMEOUT
|
Duration |
30M
|
quarkus.http.read-timeout
Http connection read timeout for blocking IO. This is the maximum amount of time a thread will wait for data, before an IOException will be thrown and the connection closed.
Environment variable: QUARKUS_HTTP_READ_TIMEOUT
|
Duration |
60S
|
quarkus.http.body.handle-file-uploads
Whether the files sent using multipart/form-data will be stored locally.
If true , they will be stored in quarkus.http.body-handler.uploads-directory and will be made available via io.vertx.ext.web.RoutingContext.fileUploads() . Otherwise, the files sent using multipart/form-data will not be stored locally, and io.vertx.ext.web.RoutingContext.fileUploads() will always return an empty collection. Note that even with this option being set to false , the multipart/form-data requests will be accepted.
Environment variable: QUARKUS_HTTP_BODY_HANDLE_FILE_UPLOADS
|
boolean |
true
|
quarkus.http.body.uploads-directory
The directory where the files sent using multipart/form-data should be stored.
Either an absolute path or a path relative to the current directory of the application process.
Environment variable: QUARKUS_HTTP_BODY_UPLOADS_DIRECTORY
|
string |
${java.io.tmpdir}/uploads
|
quarkus.http.body.merge-form-attributes
Whether the form attributes should be added to the request parameters.
If true , the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters
Environment variable: QUARKUS_HTTP_BODY_MERGE_FORM_ATTRIBUTES
|
boolean |
true
|
quarkus.http.body.delete-uploaded-files-on-end
Whether the uploaded files should be removed after serving the request.
If true the uploaded files stored in quarkus.http.body-handler.uploads-directory will be removed after handling the request. Otherwise, the files will be left there forever.
Environment variable: QUARKUS_HTTP_BODY_DELETE_UPLOADED_FILES_ON_END
|
boolean |
true
|
quarkus.http.body.preallocate-body-buffer
Whether the body buffer should pre-allocated based on the Content-Length header value.
If true the body buffer is pre-allocated according to the size read from the Content-Length header. Otherwise, the body buffer is pre-allocated to 1KB, and is resized dynamically
Environment variable: QUARKUS_HTTP_BODY_PREALLOCATE_BODY_BUFFER
|
boolean |
false
|
quarkus.http.body.multipart.file-content-types
A comma-separated list of ContentType to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.
Environment variable: QUARKUS_HTTP_BODY_MULTIPART_FILE_CONTENT_TYPES
|
list of string |
|
quarkus.http.auth.session.encryption-key
The encryption key that is used to store persistent logins (e.g. for form auth). Logins are stored in a persistent cookie that is encrypted with AES-256 using a key derived from a SHA-256 hash of the key that is provided here.
If no key is provided then an in-memory one will be generated, this will change on every restart though so it is not suitable for production environments. This must be more than 16 characters long for security reasons
Environment variable: QUARKUS_HTTP_AUTH_SESSION_ENCRYPTION_KEY
|
string |
|
quarkus.http.so-reuse-port
Enable socket reuse port (linux/macOs native transport only)
Environment variable: QUARKUS_HTTP_SO_REUSE_PORT
|
boolean |
false
|
quarkus.http.tcp-quick-ack
Enable tcp quick ack (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_QUICK_ACK
|
boolean |
false
|
Enable tcp cork (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_CORK
|
boolean |
false
|
quarkus.http.tcp-fast-open
Enable tcp fast open (linux native transport only)
Environment variable: QUARKUS_HTTP_TCP_FAST_OPEN
|
boolean |
false
|
quarkus.http.accept-backlog
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected
Environment variable: QUARKUS_HTTP_ACCEPT_BACKLOG
|
int |
-1
|
quarkus.http.initial-window-size
Set the SETTINGS_INITIAL_WINDOW_SIZE HTTP/2 setting. Indicates the sender’s initial window size (in octets) for stream-level flow control. The initial value is 2^16-1 (65,535) octets.
Environment variable: QUARKUS_HTTP_INITIAL_WINDOW_SIZE
|
int |
|
quarkus.http.domain-socket
Path to a unix domain socket
Environment variable: QUARKUS_HTTP_DOMAIN_SOCKET
|
string |
/var/run/io.quarkus.app.socket
|
quarkus.http.domain-socket-enabled
Enable listening to host:port
Environment variable: QUARKUS_HTTP_DOMAIN_SOCKET_ENABLED
|
boolean |
false
|
quarkus.http.record-request-start-time
If this is true then the request start time will be recorded to enable logging of total request time.
This has a small performance penalty, so is disabled by default.
Environment variable: QUARKUS_HTTP_RECORD_REQUEST_START_TIME
|
boolean |
false
|
quarkus.http.unhandled-error-content-type-default
Provides a hint (optional) for the default content type of responses generated for the errors not handled by the application.
If the client requested a supported content-type in request headers (e.g. "Accept: application/json", "Accept: text/html"), Quarkus will use that content type.
Otherwise, it will default to the content type configured here.
Environment variable: QUARKUS_HTTP_UNHANDLED_ERROR_CONTENT_TYPE_DEFAULT
|
|
|
quarkus.http.same-site-cookie."same-site-cookie".case-sensitive
If the cookie pattern is case-sensitive
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__CASE_SENSITIVE
|
boolean |
false
|
quarkus.http.same-site-cookie."same-site-cookie".value
The value to set in the samesite attribute
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__VALUE
|
|
required |
quarkus.http.same-site-cookie."same-site-cookie".enable-client-checker
Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ENABLE_CLIENT_CHECKER
|
boolean |
true
|
quarkus.http.same-site-cookie."same-site-cookie".add-secure-for-none
If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None.
Environment variable: QUARKUS_HTTP_SAME_SITE_COOKIE__SAME_SITE_COOKIE__ADD_SECURE_FOR_NONE
|
boolean |
true
|
Authentication configuration |
Type |
Default |
quarkus.http.auth.permission."permissions".enabled
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__ENABLED
|
boolean |
|
quarkus.http.auth.permission."permissions".policy
The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__POLICY
|
string |
required |
quarkus.http.auth.permission."permissions".methods
The methods that this permission set applies to. If this is not set then they apply to all methods. Note that if a request matches any path from any permission set, but does not match the constraint due to the method not being listed then the request will be denied. Method specific permissions take precedence over matches that do not have any methods set. This means that for example if Quarkus is configured to allow GET and POST requests to /admin to and no other permissions are configured PUT requests to /admin will be denied.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__METHODS
|
list of string |
|
quarkus.http.auth.permission."permissions".paths
The paths that this permission check applies to. If the path ends in /* then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__PATHS
|
list of string |
|
quarkus.http.auth.permission."permissions".auth-mechanism
Path specific authentication mechanism which must be used to authenticate a user. It needs to match HttpCredentialTransport authentication scheme such as 'basic', 'bearer', 'form', etc.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM
|
string |
|
quarkus.http.auth.permission."permissions".shared
Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__SHARED
|
boolean |
false
|
quarkus.http.auth.permission."permissions".applies-to
Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.
Environment variable: QUARKUS_HTTP_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO
|
|
all
|
quarkus.http.auth.policy."role-policy".roles-allowed
The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.
Environment variable: QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED
|
list of string |
**
|
quarkus.http.auth.policy."role-policy".roles."role-name"
Add roles granted to the SecurityIdentity based on the roles that the SecurityIdentity already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.
Environment variable: QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.http.auth.policy."role-policy".permissions."role-name"
Permissions granted to the SecurityIdentity if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission perm1 with actions action1 and action2 to role admin by setting quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2 configuration property. Granted permissions are used for authorization with the @PermissionsAllowed annotation.
Environment variable: QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.http.auth.policy."role-policy".permission-class
Permissions granted by this policy will be created with a java.security.Permission implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (String ) or permission name and actions (String , String[] ). Permission class must be registered for reflection if you run your application in a native mode.
Environment variable: QUARKUS_HTTP_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS
|
string |
io.quarkus.security.StringPermission
|
quarkus.http.auth.roles-mapping."role-name"
Map the SecurityIdentity roles to deployment specific roles and add the matching roles to SecurityIdentity .
For example, if SecurityIdentity has a user role and the endpoint is secured with a 'UserRole' role, use this property to map the user role to the UserRole role, and have SecurityIdentity to have both user and UserRole roles.
Environment variable: QUARKUS_HTTP_AUTH_ROLES_MAPPING__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.http.auth.certificate-role-attribute
Client certificate attribute whose values are going to be mapped to the 'SecurityIdentity' roles according to the roles mapping specified in the certificate properties file. The attribute must be either one of the Relative Distinguished Names (RDNs) or Subject Alternative Names (SANs). By default, the Common Name (CN) attribute value is used for roles mapping. Supported values are:
-
RDN type - Distinguished Name field. For example 'CN' represents Common Name field. Multivalued RNDs and multiple instances of the same attributes are currently not supported.
-
'SAN_RFC822' - Subject Alternative Name field RFC 822 Name.
-
'SAN_URI' - Subject Alternative Name field Uniform Resource Identifier (URI).
-
'SAN_ANY' - Subject Alternative Name field Other Name. Please note that only simple case of UTF8 identifier mapping is supported. For example, you can map 'other-identifier' to the SecurityIdentity roles. If you use 'openssl' tool, supported Other name definition would look like this: subjectAltName=otherName:1.2.3.4;UTF8:other-identifier
Environment variable: QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_ATTRIBUTE
|
string |
CN
|
quarkus.http.auth.certificate-role-properties
Properties file containing the client certificate attribute value to role mappings. Use it only if the mTLS authentication mechanism is enabled with either quarkus.http.ssl.client-auth=required or quarkus.http.ssl.client-auth=request .
Properties file is expected to have the CN_VALUE=role1,role,…,roleN format and should be encoded using UTF-8.
Environment variable: QUARKUS_HTTP_AUTH_CERTIFICATE_ROLE_PROPERTIES
|
path |
|
Environment variable: QUARKUS_HTTP_AUTH_REALM
|
string |
|
quarkus.http.auth.form.login-page
The login page. Redirect to login page can be disabled by setting quarkus.http.auth.form.login-page= .
Environment variable: QUARKUS_HTTP_AUTH_FORM_LOGIN_PAGE
|
string |
/login.html
|
quarkus.http.auth.form.username-parameter
Environment variable: QUARKUS_HTTP_AUTH_FORM_USERNAME_PARAMETER
|
string |
j_username
|
quarkus.http.auth.form.password-parameter
Environment variable: QUARKUS_HTTP_AUTH_FORM_PASSWORD_PARAMETER
|
string |
j_password
|
quarkus.http.auth.form.error-page
The error page. Redirect to error page can be disabled by setting quarkus.http.auth.form.error-page= .
Environment variable: QUARKUS_HTTP_AUTH_FORM_ERROR_PAGE
|
string |
/error.html
|
quarkus.http.auth.form.landing-page
The landing page to redirect to if there is no saved page to redirect back to. Redirect to landing page can be disabled by setting quarkus.http.auth.form.landing-page= .
Environment variable: QUARKUS_HTTP_AUTH_FORM_LANDING_PAGE
|
string |
/index.html
|
quarkus.http.auth.form.location-cookie
Option to control the name of the cookie used to redirect the user back to the location they want to access.
Environment variable: QUARKUS_HTTP_AUTH_FORM_LOCATION_COOKIE
|
string |
quarkus-redirect-location
|
quarkus.http.auth.form.timeout
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.
Environment variable: QUARKUS_HTTP_AUTH_FORM_TIMEOUT
|
Duration |
PT30M
|
quarkus.http.auth.form.new-cookie-interval
How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as "renewal-timeout". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user’s last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.
Environment variable: QUARKUS_HTTP_AUTH_FORM_NEW_COOKIE_INTERVAL
|
Duration |
PT1M
|
quarkus.http.auth.form.cookie-name
The cookie that is used to store the persistent session
Environment variable: QUARKUS_HTTP_AUTH_FORM_COOKIE_NAME
|
string |
quarkus-credential
|
quarkus.http.auth.form.cookie-path
The cookie path for the session and location cookies.
Environment variable: QUARKUS_HTTP_AUTH_FORM_COOKIE_PATH
|
string |
/
|
quarkus.http.auth.form.http-only-cookie
Set the HttpOnly attribute to prevent access to the cookie via JavaScript.
Environment variable: QUARKUS_HTTP_AUTH_FORM_HTTP_ONLY_COOKIE
|
boolean |
false
|
quarkus.http.auth.form.cookie-same-site
SameSite attribute for the session and location cookies.
Environment variable: QUARKUS_HTTP_AUTH_FORM_COOKIE_SAME_SITE
|
|
strict
|
The CORS config |
Type |
Default |
quarkus.http.cors.origins
Origins allowed for CORS Comma separated list of valid URLs, e.g.: http://www.quarkus.io,http://localhost:3000 In case an entry of the list is surrounded by forward slashes, it is interpreted as a regular expression.
Environment variable: QUARKUS_HTTP_CORS_ORIGINS
|
list of string |
|
quarkus.http.cors.methods
HTTP methods allowed for CORS Comma separated list of valid methods. ex: GET,PUT,POST The filter allows any method if this is not set. default: returns any requested method as valid
Environment variable: QUARKUS_HTTP_CORS_METHODS
|
list of string |
|
quarkus.http.cors.headers
HTTP headers allowed for CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition The filter allows any header if this is not set. default: returns any requested header as valid
Environment variable: QUARKUS_HTTP_CORS_HEADERS
|
list of string |
|
quarkus.http.cors.exposed-headers
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty
Environment variable: QUARKUS_HTTP_CORS_EXPOSED_HEADERS
|
list of string |
|
quarkus.http.cors.access-control-max-age
The Access-Control-Max-Age response header value indicating how long the results of a pre-flight request can be cached.
Environment variable: QUARKUS_HTTP_CORS_ACCESS_CONTROL_MAX_AGE
|
Duration |
|
quarkus.http.cors.access-control-allow-credentials
The Access-Control-Allow-Credentials header is used to tell the browsers to expose the response to front-end JavaScript code when the request’s credentials mode Request.credentials is “include”. The value of this header will default to true if quarkus.http.cors.origins property is set and there is a match with the precise Origin header.
Environment variable: QUARKUS_HTTP_CORS_ACCESS_CONTROL_ALLOW_CREDENTIALS
|
boolean |
|
Static Resources |
Type |
Default |
quarkus.http.static-resources.index-page
Set the index page when serving static resources.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_INDEX_PAGE
|
string |
index.html
|
quarkus.http.static-resources.include-hidden
Set whether hidden files should be served.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_INCLUDE_HIDDEN
|
boolean |
true
|
quarkus.http.static-resources.enable-range-support
Set whether range requests (resumable downloads; media streaming) should be enabled.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_ENABLE_RANGE_SUPPORT
|
boolean |
true
|
quarkus.http.static-resources.caching-enabled
Set whether cache handling is enabled.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_CACHING_ENABLED
|
boolean |
true
|
quarkus.http.static-resources.cache-entry-timeout
Set the cache entry timeout. The default is 30 seconds.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_CACHE_ENTRY_TIMEOUT
|
Duration |
30S
|
quarkus.http.static-resources.max-age
Set value for max age in caching headers. The default is 24 hours.
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_MAX_AGE
|
Duration |
24H
|
quarkus.http.static-resources.max-cache-size
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_MAX_CACHE_SIZE
|
int |
10000
|
quarkus.http.static-resources.content-encoding
Content encoding for text related files
Environment variable: QUARKUS_HTTP_STATIC_RESOURCES_CONTENT_ENCODING
|
Charset |
UTF-8
|
Server limits |
Type |
Default |
quarkus.http.limits.max-header-size
The maximum length of all headers.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_HEADER_SIZE
|
MemorySize |
20K
|
quarkus.http.limits.max-body-size
The maximum size of a request body.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_BODY_SIZE
|
MemorySize |
10240K
|
quarkus.http.limits.max-chunk-size
Environment variable: QUARKUS_HTTP_LIMITS_MAX_CHUNK_SIZE
|
MemorySize |
8192
|
quarkus.http.limits.max-initial-line-length
The maximum length of the initial line (e.g. "GET / HTTP/1.0" ).
Environment variable: QUARKUS_HTTP_LIMITS_MAX_INITIAL_LINE_LENGTH
|
int |
4096
|
quarkus.http.limits.max-form-attribute-size
The maximum length of a form attribute.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_FORM_ATTRIBUTE_SIZE
|
MemorySize |
2048
|
quarkus.http.limits.max-form-fields
Set the maximum number of fields of a form. Set to -1 to allow unlimited number of attributes.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_FORM_FIELDS
|
int |
256
|
quarkus.http.limits.max-form-buffered-bytes
Set the maximum number of bytes a server can buffer when decoding a form. Set to -1 to allow unlimited length
Environment variable: QUARKUS_HTTP_LIMITS_MAX_FORM_BUFFERED_BYTES
|
MemorySize |
1K
|
quarkus.http.limits.max-parameters
The maximum number of HTTP request parameters permitted for incoming requests.
If a client sends more than this number of parameters in a request, the connection is closed.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_PARAMETERS
|
int |
1000
|
quarkus.http.limits.max-connections
The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_CONNECTIONS
|
int |
|
quarkus.http.limits.header-table-size
Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.
Allows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is 4,096 octets.
Environment variable: QUARKUS_HTTP_LIMITS_HEADER_TABLE_SIZE
|
long |
|
quarkus.http.limits.max-concurrent-streams
Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.
Indicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_CONCURRENT_STREAMS
|
long |
|
quarkus.http.limits.max-frame-size
Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is 2^14 (16,384) octets.
Environment variable: QUARKUS_HTTP_LIMITS_MAX_FRAME_SIZE
|
int |
|
quarkus.http.limits.max-header-list-size
Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is 8192
Environment variable: QUARKUS_HTTP_LIMITS_MAX_HEADER_LIST_SIZE
|
long |
|
quarkus.http.limits.rst-flood-max-rst-frame-per-window
Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is 200 , setting zero or a negative value, disables flood protection.
Environment variable: QUARKUS_HTTP_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW
|
int |
|
quarkus.http.limits.rst-flood-window-duration
Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks.. The default value is 30 s , setting zero or a negative value, disables flood protection.
Environment variable: QUARKUS_HTTP_LIMITS_RST_FLOOD_WINDOW_DURATION
|
Duration |
|
Access logs |
Type |
Default |
quarkus.http.access-log.enabled
If access logging is enabled. By default this will log via the standard logging facility
Environment variable: QUARKUS_HTTP_ACCESS_LOG_ENABLED
|
boolean |
false
|
quarkus.http.access-log.exclude-pattern
A regular expression that can be used to exclude some paths from logging.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_EXCLUDE_PATTERN
|
string |
|
quarkus.http.access-log.pattern
If this is the string common , combined or long then this will use one of the specified named formats:
-
common: %h %l %u %t "%r" %s %b
-
combined: %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}"
-
long: %r\n%{ALL_REQUEST_HEADERS}
Otherwise, consult the Quarkus documentation for the full list of variables that can be used.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_PATTERN
|
string |
common
|
quarkus.http.access-log.log-to-file
If logging should be done to a separate file.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_LOG_TO_FILE
|
boolean |
false
|
quarkus.http.access-log.base-file-name
The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_BASE_FILE_NAME
|
string |
quarkus
|
quarkus.http.access-log.log-directory
The log directory to use when logging access to a file If this is not set then the current working directory is used.
Environment variable: QUARKUS_HTTP_ACCESS_LOG_LOG_DIRECTORY
|
string |
|
quarkus.http.access-log.log-suffix
Environment variable: QUARKUS_HTTP_ACCESS_LOG_LOG_SUFFIX
|
string |
.log
|
quarkus.http.access-log.category
The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty).
Environment variable: QUARKUS_HTTP_ACCESS_LOG_CATEGORY
|
string |
io.quarkus.http.access-log
|
quarkus.http.access-log.rotate
If the log should be rotated daily
Environment variable: QUARKUS_HTTP_ACCESS_LOG_ROTATE
|
boolean |
true
|
quarkus.http.access-log.consolidate-rerouted-requests
If rerouted requests should be consolidated into one log entry
Environment variable: QUARKUS_HTTP_ACCESS_LOG_CONSOLIDATE_REROUTED_REQUESTS
|
boolean |
false
|
Traffic shaping |
Type |
Default |
quarkus.http.traffic-shaping.enabled
Enables the traffic shaping.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_ENABLED
|
boolean |
false
|
quarkus.http.traffic-shaping.inbound-global-bandwidth
Set bandwidth limit in bytes per second for inbound connections. If not set, no limits are applied.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_INBOUND_GLOBAL_BANDWIDTH
|
MemorySize |
|
quarkus.http.traffic-shaping.outbound-global-bandwidth
Set bandwidth limit in bytes per second for outbound connections. If not set, no limits are applied.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_OUTBOUND_GLOBAL_BANDWIDTH
|
MemorySize |
|
quarkus.http.traffic-shaping.max-delay
Set the maximum delay to wait in case of traffic excess. Default is 15s. Must be less than the HTTP timeout.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_MAX_DELAY
|
Duration |
|
quarkus.http.traffic-shaping.check-interval
Set the delay between two computations of performances for channels. If set to 0, no stats are computed. Despite 0 is accepted (no accounting), it is recommended to set a positive value for the check interval, even if it is high since the precision of the traffic shaping depends on the period where the traffic is computed. In this case, a suggested value is something close to 5 or 10 minutes.
If not default, it defaults to 1s.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_CHECK_INTERVAL
|
Duration |
|
quarkus.http.traffic-shaping.peak-outbound-global-bandwidth
Set the maximum global write size in bytes per second allowed in the buffer globally for all channels before write are suspended. The default value is 400 MB.
Environment variable: QUARKUS_HTTP_TRAFFIC_SHAPING_PEAK_OUTBOUND_GLOBAL_BANDWIDTH
|
MemorySize |
|
Additional HTTP Headers always sent in the response |
Type |
Default |
quarkus.http.header."header".path
The path this header should be applied
Environment variable: QUARKUS_HTTP_HEADER__HEADER__PATH
|
string |
/*
|
quarkus.http.header."header".value
The value for this header configuration
Environment variable: QUARKUS_HTTP_HEADER__HEADER__VALUE
|
string |
required |
quarkus.http.header."header".methods
The HTTP methods for this header configuration
Environment variable: QUARKUS_HTTP_HEADER__HEADER__METHODS
|
list of string |
|
Additional HTTP configuration per path |
Type |
Default |
quarkus.http.filter."filter".matches
A regular expression for the paths matching this configuration
Environment variable: QUARKUS_HTTP_FILTER__FILTER__MATCHES
|
string |
required |
quarkus.http.filter."filter".header."header-name"
Additional HTTP Headers always sent in the response
Environment variable: QUARKUS_HTTP_FILTER__FILTER__HEADER__HEADER_NAME_
|
Map<String,String> |
|
quarkus.http.filter."filter".methods
The HTTP methods for this path configuration
Environment variable: QUARKUS_HTTP_FILTER__FILTER__METHODS
|
list of string |
|
quarkus.http.filter."filter".order
Order in which this path config is applied. Higher priority takes precedence
Environment variable: QUARKUS_HTTP_FILTER__FILTER__ORDER
|
int |
|
Proxy |
Type |
Default |
quarkus.http.proxy.use-proxy-protocol
Set whether the server should use the HA PROXY protocol when serving requests from behind a proxy. (see the PROXY Protocol). When set to true , the remote address returned will be the one from the actual connecting client. If it is set to false (default), the remote address returned will be the one from the proxy.
Environment variable: QUARKUS_HTTP_PROXY_USE_PROXY_PROTOCOL
|
boolean |
false
|
quarkus.http.proxy.proxy-address-forwarding
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as X-Forwarded-For . This should only be set if you are behind a proxy that sets these headers.
Environment variable: QUARKUS_HTTP_PROXY_PROXY_ADDRESS_FORWARDING
|
boolean |
false
|
quarkus.http.proxy.allow-forwarded
If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used. In case the not standard X-Forwarded-For header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-x-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_HTTP_PROXY_ALLOW_FORWARDED
|
boolean |
false
|
quarkus.http.proxy.allow-x-forwarded
If either this or allow-forwarded are true and proxy address forwarding is enabled then the not standard Forwarded header will be used. In case the standard Forwarded header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_HTTP_PROXY_ALLOW_X_FORWARDED
|
boolean |
|
quarkus.http.proxy.enable-forwarded-host
Enable override the received request’s host through a forwarded host header.
Environment variable: QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_HOST
|
boolean |
false
|
quarkus.http.proxy.forwarded-host-header
Configure the forwarded host header to be used if override enabled.
Environment variable: QUARKUS_HTTP_PROXY_FORWARDED_HOST_HEADER
|
string |
X-Forwarded-Host
|
quarkus.http.proxy.enable-forwarded-prefix
Enable prefix the received request’s path with a forwarded prefix header.
Environment variable: QUARKUS_HTTP_PROXY_ENABLE_FORWARDED_PREFIX
|
boolean |
false
|
quarkus.http.proxy.forwarded-prefix-header
Configure the forwarded prefix header to be used if prefixing enabled.
Environment variable: QUARKUS_HTTP_PROXY_FORWARDED_PREFIX_HEADER
|
string |
X-Forwarded-Prefix
|
quarkus.http.proxy.trusted-proxies
Configure the list of trusted proxy addresses. Received Forwarded , X-Forwarded or X-Forwarded-* headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.
Examples of a socket address in the form of host or host:port :
-
127.0.0.1:8084
-
[0:0:0:0:0:0:0:1]
-
[0:0:0:0:0:0:0:1]:8084
-
[::]
-
localhost
-
localhost:8084
Examples of a CIDR notation:
Please bear in mind that IPv4 CIDR won’t match request sent from the IPv6 address and the other way around.
Environment variable: QUARKUS_HTTP_PROXY_TRUSTED_PROXIES
|
list of TrustedProxyCheckPart |
All proxy addresses are trusted
|
quarkus.dev-ui.history-size
The number of history log entries to remember.
Environment variable: QUARKUS_DEV_UI_HISTORY_SIZE
|
int |
50
|
quarkus.dev-ui.show-json-rpc-log
Show the JsonRPC Log. Useful for extension developers
Environment variable: QUARKUS_DEV_UI_SHOW_JSON_RPC_LOG
|
boolean |
false
|
More hosts allowed for Dev UI Comma separated list of valid URLs, e.g.: www.quarkus.io, myhost.com By default localhost and 127.0.0.1 will always be allowed
Environment variable: QUARKUS_DEV_UI_HOSTS
|
list of string |
|
quarkus.dev-ui.cors.enabled
Environment variable: QUARKUS_DEV_UI_CORS_ENABLED
|
boolean |
true
|
quarkus.management.enabled
Enables / Disables the usage of a separate interface/port to expose the management endpoints. If sets to true , the management endpoints will be exposed to a different HTTP server. This avoids exposing the management endpoints on a publicly available server.
Environment variable: QUARKUS_MANAGEMENT_ENABLED
|
boolean |
false
|
quarkus.management.auth.basic
If basic auth should be enabled.
Environment variable: QUARKUS_MANAGEMENT_AUTH_BASIC
|
boolean |
|
quarkus.management.auth.proactive
If this is true and credentials are present then a user will always be authenticated before the request progresses. If this is false then an attempt will only be made to authenticate the user if a permission check is performed or the current user is required for some other reason.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PROACTIVE
|
boolean |
true
|
quarkus.management.ssl.client-auth
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
Environment variable: QUARKUS_MANAGEMENT_SSL_CLIENT_AUTH
|
|
none
|
quarkus.management.root-path
A common root path for management endpoints. Various extension-provided management endpoints such as metrics and health are deployed under this path by default.
Environment variable: QUARKUS_MANAGEMENT_ROOT_PATH
|
string |
/q
|
quarkus.management.enable-compression
If responses should be compressed.
Note that this will attempt to compress all responses, to avoid compressing already compressed content (such as images) you need to set the following header:
Content-Encoding: identity
Which will tell vert.x not to compress the response.
Environment variable: QUARKUS_MANAGEMENT_ENABLE_COMPRESSION
|
boolean |
false
|
quarkus.management.enable-decompression
When enabled, vert.x will decompress the request’s body if it’s compressed.
Note that the compression format (e.g., gzip) must be specified in the Content-Encoding header in the request.
Environment variable: QUARKUS_MANAGEMENT_ENABLE_DECOMPRESSION
|
boolean |
false
|
quarkus.management.compression-level
The compression level used when compression support is enabled.
Environment variable: QUARKUS_MANAGEMENT_COMPRESSION_LEVEL
|
int |
|
quarkus.management.auth.roles-mapping."role-name"
Map the SecurityIdentity roles to deployment specific roles and add the matching roles to SecurityIdentity .
For example, if SecurityIdentity has a user role and the endpoint is secured with a 'UserRole' role, use this property to map the user role to the UserRole role, and have SecurityIdentity to have both user and UserRole roles.
Environment variable: QUARKUS_MANAGEMENT_AUTH_ROLES_MAPPING__ROLE_NAME_
|
list of Map<String,List<String>> |
|
Environment variable: QUARKUS_MANAGEMENT_PORT
|
int |
9000
|
quarkus.management.test-port
Environment variable: QUARKUS_MANAGEMENT_TEST_PORT
|
int |
9001
|
Defaulting to 0.0.0.0 makes it easier to deploy Quarkus to container, however it is not suitable for dev/test mode as other people on the network can connect to your development machine.
Environment variable: QUARKUS_MANAGEMENT_HOST
|
string |
|
quarkus.management.host-enabled
Enable listening to host:port
Environment variable: QUARKUS_MANAGEMENT_HOST_ENABLED
|
boolean |
true
|
quarkus.management.ssl.certificate.credentials-provider
The CredentialsProvider . If this property is configured, then a matching 'CredentialsProvider' will be used to get the keystore, keystore key, and truststore passwords unless these passwords have already been configured.
Please note that using MicroProfile ConfigSource which is directly supported by Quarkus Configuration should be preferred unless using CredentialsProvider provides for some additional security and dynamism.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER
|
string |
|
quarkus.management.ssl.certificate.credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.management.ssl.certificate.files
The list of path to server certificates using the PEM format. Specifying multiple files requires SNI to be enabled.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_FILES
|
list of path |
|
quarkus.management.ssl.certificate.key-files
The list of path to server certificates private key files using the PEM format. Specifying multiple files requires SNI to be enabled.
The order of the key files must match the order of the certificates.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_FILES
|
list of path |
|
quarkus.management.ssl.certificate.key-store-file
An optional keystore that holds the certificate information instead of specifying separate files.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE
|
path |
|
quarkus.management.ssl.certificate.key-store-file-type
An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_FILE_TYPE
|
string |
|
quarkus.management.ssl.certificate.key-store-provider
An optional parameter to specify a provider of the keystore file. If not given, the provider is automatically detected based on the keystore file type.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PROVIDER
|
string |
|
quarkus.management.ssl.certificate.key-store-password
A parameter to specify the password of the keystore file. If not given, and if it can not be retrieved from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD
|
string |
password
|
quarkus.management.ssl.certificate.key-store-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the key store file from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_PASSWORD_KEY
|
string |
|
quarkus.management.ssl.certificate.key-store-alias
An optional parameter to select a specific key in the keystore. When SNI is disabled, and the keystore contains multiple keys and no alias is specified; the behavior is undefined.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS
|
string |
|
quarkus.management.ssl.certificate.key-store-alias-password
An optional parameter to define the password for the key, in case it is different from key-store-password If not given, it might be retrieved from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD
|
string |
|
quarkus.management.ssl.certificate.key-store-alias-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password for the alias from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_KEY_STORE_ALIAS_PASSWORD_KEY
|
string |
|
quarkus.management.ssl.certificate.trust-store-file
An optional trust store that holds the certificate information of the trusted certificates.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE
|
path |
|
quarkus.management.ssl.certificate.trust-store-files
An optional list of trusted certificates using the PEM format. If you pass multiple files, you must use the PEM format.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILES
|
list of path |
|
quarkus.management.ssl.certificate.trust-store-file-type
An optional parameter to specify the type of the trust store file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_FILE_TYPE
|
string |
|
quarkus.management.ssl.certificate.trust-store-provider
An optional parameter to specify a provider of the trust store file. If not given, the provider is automatically detected based on the trust store file type.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PROVIDER
|
string |
|
quarkus.management.ssl.certificate.trust-store-password
A parameter to specify the password of the trust store file. If not given, it might be retrieved from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD
|
string |
|
quarkus.management.ssl.certificate.trust-store-password-key
A parameter to specify a CredentialsProvider property key, which can be used to get the password of the trust store file from CredentialsProvider .
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_PASSWORD_KEY
|
string |
|
quarkus.management.ssl.certificate.trust-store-cert-alias
An optional parameter to trust a single certificate from the trust store rather than trusting all certificates in the store.
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_TRUST_STORE_CERT_ALIAS
|
string |
|
quarkus.management.ssl.certificate.reload-period
When set, the configured certificate will be reloaded after the given period. Note that the certificate will be reloaded only if the file has been modified.
Also, the update can also occur when the TLS certificate is configured using paths (and not in-memory).
The reload period must be equal or greater than 30 seconds. If not set, the certificate will not be reloaded.
|
It’s recommended to use the TLS registry to handle the certificate reloading.
|
Environment variable: QUARKUS_MANAGEMENT_SSL_CERTIFICATE_RELOAD_PERIOD
|
Duration |
|
quarkus.management.ssl.cipher-suites
The cipher suites to use. If none is given, a reasonable default is selected.
Environment variable: QUARKUS_MANAGEMENT_SSL_CIPHER_SUITES
|
list of string |
|
quarkus.management.ssl.protocols
Sets the ordered list of enabled SSL/TLS protocols.
If not set, it defaults to "TLSv1.3, TLSv1.2" . The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 . To only enable TLSv1.3 , set the value to to "TLSv1.3" .
Note that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.
Environment variable: QUARKUS_MANAGEMENT_SSL_PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
quarkus.management.ssl.sni
Enables Server Name Indication (SNI), an TLS extension allowing the server to use multiple certificates. The client indicate the server name during the TLS handshake, allowing the server to select the right certificate.
Environment variable: QUARKUS_MANAGEMENT_SSL_SNI
|
boolean |
false
|
quarkus.management.tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration is set, and quarkus.tls.* is not configured, then, quarkus.management.ssl will be used.
Environment variable: QUARKUS_MANAGEMENT_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.management.handle-100-continue-automatically
When set to true , the HTTP server automatically sends 100 CONTINUE response when the request expects it (with the Expect: 100-Continue header).
Environment variable: QUARKUS_MANAGEMENT_HANDLE_100_CONTINUE_AUTOMATICALLY
|
boolean |
false
|
quarkus.management.limits.max-header-size
The maximum length of all headers.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_SIZE
|
MemorySize |
20K
|
quarkus.management.limits.max-body-size
The maximum size of a request body.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_BODY_SIZE
|
MemorySize |
10240K
|
quarkus.management.limits.max-chunk-size
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_CHUNK_SIZE
|
MemorySize |
8192
|
quarkus.management.limits.max-initial-line-length
The maximum length of the initial line (e.g. "GET / HTTP/1.0" ).
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_INITIAL_LINE_LENGTH
|
int |
4096
|
quarkus.management.limits.max-form-attribute-size
The maximum length of a form attribute.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_ATTRIBUTE_SIZE
|
MemorySize |
2048
|
quarkus.management.limits.max-form-fields
Set the maximum number of fields of a form. Set to -1 to allow unlimited number of attributes.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_FIELDS
|
int |
256
|
quarkus.management.limits.max-form-buffered-bytes
Set the maximum number of bytes a server can buffer when decoding a form. Set to -1 to allow unlimited length
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_FORM_BUFFERED_BYTES
|
MemorySize |
1K
|
quarkus.management.limits.max-parameters
The maximum number of HTTP request parameters permitted for incoming requests.
If a client sends more than this number of parameters in a request, the connection is closed.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_PARAMETERS
|
int |
1000
|
quarkus.management.limits.max-connections
The maximum number of connections that are allowed at any one time. If this is set it is recommended to set a short idle timeout.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_CONNECTIONS
|
int |
|
quarkus.management.limits.header-table-size
Set the SETTINGS_HEADER_TABLE_SIZE HTTP/2 setting.
Allows the sender to inform the remote endpoint of the maximum size of the header compression table used to decode header blocks, in octets. The encoder can select any size equal to or less than this value by using signaling specific to the header compression format inside a header block. The initial value is 4,096 octets.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_HEADER_TABLE_SIZE
|
long |
|
quarkus.management.limits.max-concurrent-streams
Set SETTINGS_MAX_CONCURRENT_STREAMS HTTP/2 setting.
Indicates the maximum number of concurrent streams that the sender will allow. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. Initially, there is no limit to this value. It is recommended that this value be no smaller than 100, to not unnecessarily limit parallelism.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_CONCURRENT_STREAMS
|
long |
|
quarkus.management.limits.max-frame-size
Set the SETTINGS_MAX_FRAME_SIZE HTTP/2 setting. Indicates the size of the largest frame payload that the sender is willing to receive, in octets. The initial value is 2^14 (16,384) octets.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_FRAME_SIZE
|
int |
|
quarkus.management.limits.max-header-list-size
Set the SETTINGS_MAX_HEADER_LIST_SIZE HTTP/2 setting. This advisory setting informs a peer of the maximum size of header list that the sender is prepared to accept, in octets. The value is based on the uncompressed size of header fields, including the length of the name and value in octets plus an overhead of 32 octets for each header field. The default value is 8192
Environment variable: QUARKUS_MANAGEMENT_LIMITS_MAX_HEADER_LIST_SIZE
|
long |
|
quarkus.management.limits.rst-flood-max-rst-frame-per-window
Set the max number of RST frame allowed per time window, this is used to prevent HTTP/2 RST frame flood DDOS attacks. The default value is 200 , setting zero or a negative value, disables flood protection.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_MAX_RST_FRAME_PER_WINDOW
|
int |
|
quarkus.management.limits.rst-flood-window-duration
Set the duration of the time window when checking the max number of RST frames, this is used to prevent HTTP/2 RST frame flood DDOS attacks.. The default value is 30 s , setting zero or a negative value, disables flood protection.
Environment variable: QUARKUS_MANAGEMENT_LIMITS_RST_FLOOD_WINDOW_DURATION
|
Duration |
|
quarkus.management.idle-timeout
Http connection idle timeout
Environment variable: QUARKUS_MANAGEMENT_IDLE_TIMEOUT
|
Duration |
30M
|
quarkus.management.body.handle-file-uploads
Whether the files sent using multipart/form-data will be stored locally.
If true , they will be stored in quarkus.http.body-handler.uploads-directory and will be made available via io.vertx.ext.web.RoutingContext.fileUploads() . Otherwise, the files sent using multipart/form-data will not be stored locally, and io.vertx.ext.web.RoutingContext.fileUploads() will always return an empty collection. Note that even with this option being set to false , the multipart/form-data requests will be accepted.
Environment variable: QUARKUS_MANAGEMENT_BODY_HANDLE_FILE_UPLOADS
|
boolean |
true
|
quarkus.management.body.uploads-directory
The directory where the files sent using multipart/form-data should be stored.
Either an absolute path or a path relative to the current directory of the application process.
Environment variable: QUARKUS_MANAGEMENT_BODY_UPLOADS_DIRECTORY
|
string |
${java.io.tmpdir}/uploads
|
quarkus.management.body.merge-form-attributes
Whether the form attributes should be added to the request parameters.
If true , the form attributes will be added to the request parameters; otherwise the form parameters will not be added to the request parameters
Environment variable: QUARKUS_MANAGEMENT_BODY_MERGE_FORM_ATTRIBUTES
|
boolean |
true
|
quarkus.management.body.delete-uploaded-files-on-end
Whether the uploaded files should be removed after serving the request.
If true the uploaded files stored in quarkus.http.body-handler.uploads-directory will be removed after handling the request. Otherwise, the files will be left there forever.
Environment variable: QUARKUS_MANAGEMENT_BODY_DELETE_UPLOADED_FILES_ON_END
|
boolean |
true
|
quarkus.management.body.preallocate-body-buffer
Whether the body buffer should pre-allocated based on the Content-Length header value.
If true the body buffer is pre-allocated according to the size read from the Content-Length header. Otherwise, the body buffer is pre-allocated to 1KB, and is resized dynamically
Environment variable: QUARKUS_MANAGEMENT_BODY_PREALLOCATE_BODY_BUFFER
|
boolean |
false
|
quarkus.management.body.multipart.file-content-types
A comma-separated list of ContentType to indicate whether a given multipart field should be handled as a file part. You can use this setting to force HTTP-based extensions to parse a message part as a file based on its content type. For now, this setting only works when using RESTEasy Reactive.
Environment variable: QUARKUS_MANAGEMENT_BODY_MULTIPART_FILE_CONTENT_TYPES
|
list of string |
|
quarkus.management.accept-backlog
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected
Environment variable: QUARKUS_MANAGEMENT_ACCEPT_BACKLOG
|
int |
-1
|
quarkus.management.domain-socket
Path to a unix domain socket
Environment variable: QUARKUS_MANAGEMENT_DOMAIN_SOCKET
|
string |
/var/run/io.quarkus.management.socket
|
quarkus.management.domain-socket-enabled
Enable listening to host:port
Environment variable: QUARKUS_MANAGEMENT_DOMAIN_SOCKET_ENABLED
|
boolean |
false
|
quarkus.management.proxy.use-proxy-protocol
Set whether the server should use the HA PROXY protocol when serving requests from behind a proxy. (see the PROXY Protocol). When set to true , the remote address returned will be the one from the actual connecting client. If it is set to false (default), the remote address returned will be the one from the proxy.
Environment variable: QUARKUS_MANAGEMENT_PROXY_USE_PROXY_PROTOCOL
|
boolean |
false
|
quarkus.management.proxy.proxy-address-forwarding
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as X-Forwarded-For . This should only be set if you are behind a proxy that sets these headers.
Environment variable: QUARKUS_MANAGEMENT_PROXY_PROXY_ADDRESS_FORWARDING
|
boolean |
false
|
quarkus.management.proxy.allow-forwarded
If this is true and proxy address forwarding is enabled then the standard Forwarded header will be used. In case the not standard X-Forwarded-For header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-x-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_MANAGEMENT_PROXY_ALLOW_FORWARDED
|
boolean |
false
|
quarkus.management.proxy.allow-x-forwarded
If either this or allow-forwarded are true and proxy address forwarding is enabled then the not standard Forwarded header will be used. In case the standard Forwarded header is enabled and detected on HTTP requests, the standard header has the precedence. Activating this together with quarkus.http.proxy.allow-forwarded has security implications as clients can forge requests with a forwarded header that is not overwritten by the proxy. Therefore, proxies should strip unexpected X-Forwarded or X-Forwarded-* headers from the client.
Environment variable: QUARKUS_MANAGEMENT_PROXY_ALLOW_X_FORWARDED
|
boolean |
|
quarkus.management.proxy.enable-forwarded-host
Enable override the received request’s host through a forwarded host header.
Environment variable: QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_HOST
|
boolean |
false
|
quarkus.management.proxy.forwarded-host-header
Configure the forwarded host header to be used if override enabled.
Environment variable: QUARKUS_MANAGEMENT_PROXY_FORWARDED_HOST_HEADER
|
string |
X-Forwarded-Host
|
quarkus.management.proxy.enable-forwarded-prefix
Enable prefix the received request’s path with a forwarded prefix header.
Environment variable: QUARKUS_MANAGEMENT_PROXY_ENABLE_FORWARDED_PREFIX
|
boolean |
false
|
quarkus.management.proxy.forwarded-prefix-header
Configure the forwarded prefix header to be used if prefixing enabled.
Environment variable: QUARKUS_MANAGEMENT_PROXY_FORWARDED_PREFIX_HEADER
|
string |
X-Forwarded-Prefix
|
quarkus.management.proxy.trusted-proxies
Configure the list of trusted proxy addresses. Received Forwarded , X-Forwarded or X-Forwarded-* headers from any other proxy address will be ignored. The trusted proxy address should be specified as the IP address (IPv4 or IPv6), hostname or Classless Inter-Domain Routing (CIDR) notation. Please note that Quarkus needs to perform DNS lookup for all hostnames during the request. For that reason, using hostnames is not recommended.
Examples of a socket address in the form of host or host:port :
-
127.0.0.1:8084
-
[0:0:0:0:0:0:0:1]
-
[0:0:0:0:0:0:0:1]:8084
-
[::]
-
localhost
-
localhost:8084
Examples of a CIDR notation:
Please bear in mind that IPv4 CIDR won’t match request sent from the IPv6 address and the other way around.
Environment variable: QUARKUS_MANAGEMENT_PROXY_TRUSTED_PROXIES
|
list of TrustedProxyCheckPart |
All proxy addresses are trusted
|
quarkus.management.auth.permission."permissions".enabled
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__ENABLED
|
boolean |
|
quarkus.management.auth.permission."permissions".policy
The HTTP policy that this permission set is linked to. There are three built-in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__POLICY
|
string |
required |
quarkus.management.auth.permission."permissions".methods
The methods that this permission set applies to. If this is not set then they apply to all methods. Note that if a request matches any path from any permission set, but does not match the constraint due to the method not being listed then the request will be denied. Method specific permissions take precedence over matches that do not have any methods set. This means that for example if Quarkus is configured to allow GET and POST requests to /admin to and no other permissions are configured PUT requests to /admin will be denied.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__METHODS
|
list of string |
|
quarkus.management.auth.permission."permissions".paths
The paths that this permission check applies to. If the path ends in /* then this is treated as a path prefix, otherwise it is treated as an exact match. Matches are done on a length basis, so the most specific path match takes precedence. If multiple permission sets match the same path then explicit methods matches take precedence over matches without methods set, otherwise the most restrictive permissions are applied.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__PATHS
|
list of string |
|
quarkus.management.auth.permission."permissions".auth-mechanism
Path specific authentication mechanism which must be used to authenticate a user. It needs to match HttpCredentialTransport authentication scheme such as 'basic', 'bearer', 'form', etc.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__AUTH_MECHANISM
|
string |
|
quarkus.management.auth.permission."permissions".shared
Indicates that this policy always applies to the matched paths in addition to the policy with a winning path. Avoid creating more than one shared policy to minimize the performance impact.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__SHARED
|
boolean |
false
|
quarkus.management.auth.permission."permissions".applies-to
Whether permission check should be applied on all matching paths, or paths specific for the Jakarta REST resources.
Environment variable: QUARKUS_MANAGEMENT_AUTH_PERMISSION__PERMISSIONS__APPLIES_TO
|
|
all
|
quarkus.management.auth.policy."role-policy".roles-allowed
The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.
Environment variable: QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES_ALLOWED
|
list of string |
**
|
quarkus.management.auth.policy."role-policy".roles."role-name"
Add roles granted to the SecurityIdentity based on the roles that the SecurityIdentity already have. For example, the Quarkus OIDC extension can map roles from the verified JWT access token, and you may want to remap them to a deployment specific roles.
Environment variable: QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__ROLES__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.management.auth.policy."role-policy".permissions."role-name"
Permissions granted to the SecurityIdentity if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission perm1 with actions action1 and action2 to role admin by setting quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2 configuration property. Granted permissions are used for authorization with the @PermissionsAllowed annotation.
Environment variable: QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSIONS__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.management.auth.policy."role-policy".permission-class
Permissions granted by this policy will be created with a java.security.Permission implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (String ) or permission name and actions (String , String[] ). Permission class must be registered for reflection if you run your application in a native mode.
Environment variable: QUARKUS_MANAGEMENT_AUTH_POLICY__ROLE_POLICY__PERMISSION_CLASS
|
string |
io.quarkus.security.StringPermission
|
quarkus.management.header."header".path
The path this header should be applied
Environment variable: QUARKUS_MANAGEMENT_HEADER__HEADER__PATH
|
string |
/*
|
quarkus.management.header."header".value
The value for this header configuration
Environment variable: QUARKUS_MANAGEMENT_HEADER__HEADER__VALUE
|
string |
required |
quarkus.management.header."header".methods
The HTTP methods for this header configuration
Environment variable: QUARKUS_MANAGEMENT_HEADER__HEADER__METHODS
|
list of string |
|
quarkus.management.filter."filter".matches
A regular expression for the paths matching this configuration
Environment variable: QUARKUS_MANAGEMENT_FILTER__FILTER__MATCHES
|
string |
required |
quarkus.management.filter."filter".header."header-name"
Additional HTTP Headers always sent in the response
Environment variable: QUARKUS_MANAGEMENT_FILTER__FILTER__HEADER__HEADER_NAME_
|
Map<String,String> |
|
quarkus.management.filter."filter".methods
The HTTP methods for this path configuration
Environment variable: QUARKUS_MANAGEMENT_FILTER__FILTER__METHODS
|
list of string |
|
quarkus.management.filter."filter".order
Order in which this path config is applied. Higher priority takes precedence
Environment variable: QUARKUS_MANAGEMENT_FILTER__FILTER__ORDER
|
int |
|
Elasticsearch REST client common |
Type |
Default |
quarkus.elasticsearch.health.enabled
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_ELASTICSEARCH_HEALTH_ENABLED
|
boolean |
true
|
quarkus.elasticsearch.hosts
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_HOSTS
|
list of host:port |
localhost:9200
|
quarkus.elasticsearch.protocol
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_ELASTICSEARCH_PROTOCOL
|
string |
http
|
quarkus.elasticsearch.username
The username for basic HTTP authentication.
Environment variable: QUARKUS_ELASTICSEARCH_USERNAME
|
string |
|
quarkus.elasticsearch.password
The password for basic HTTP authentication.
Environment variable: QUARKUS_ELASTICSEARCH_PASSWORD
|
string |
|
quarkus.elasticsearch.connection-timeout
Environment variable: QUARKUS_ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration |
1S
|
quarkus.elasticsearch.socket-timeout
Environment variable: QUARKUS_ELASTICSEARCH_SOCKET_TIMEOUT
|
Duration |
30S
|
quarkus.elasticsearch.max-connections
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
quarkus.elasticsearch.max-connections-per-route
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
quarkus.elasticsearch.io-thread-counts
The number of IO thread. By default, this is the number of locally detected processors.
Thread counts higher than the number of processors should not be necessary because the I/O threads rely on non-blocking operations, but you may want to use a thread count lower than the number of processors.
Environment variable: QUARKUS_ELASTICSEARCH_IO_THREAD_COUNTS
|
int |
|
quarkus.elasticsearch.discovery.enabled
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
quarkus.elasticsearch.discovery.refresh-interval
Refresh interval of the node list.
Environment variable: QUARKUS_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration |
5M
|
Dev Services |
Type |
Default |
quarkus.elasticsearch.devservices.enabled
Whether this Dev Service should start with the application in dev mode or tests.
Dev Services are enabled by default
unless connection configuration (e.g. quarkus.elasticsearch.hosts ) is set explicitly.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.elasticsearch.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_PORT
|
int |
|
quarkus.elasticsearch.devservices.distribution
The Elasticsearch distribution to use.
Defaults to a distribution inferred from the explicitly configured image-name (if any),
or by default to the distribution configured in depending extensions (e.g. Hibernate Search),
or by default to elastic .
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_DISTRIBUTION
|
|
|
quarkus.elasticsearch.devservices.image-name
The Elasticsearch container image to use.
Defaults depend on the configured distribution :
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.elasticsearch.devservices.java-opts
The value for the ES_JAVA_OPTS env variable.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_JAVA_OPTS
|
string |
-Xms512m -Xmx1g
|
quarkus.elasticsearch.devservices.shared
Whether the Elasticsearch 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 Elasticsearch starts a new container.
The discovery uses the quarkus-dev-service-elasticsearch label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.elasticsearch.devservices.service-name
The value of the quarkus-dev-service-elasticsearch 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 Elasticsearch looks for a container with the quarkus-dev-service-elasticsearch 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-elasticsearch label set to the specified value.
This property is used when you need multiple shared Elasticsearch servers.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SERVICE_NAME
|
string |
elasticsearch
|
quarkus.elasticsearch.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.elasticsearch.devservices.reuse
Whether to keep Dev Service containers running after a dev mode session or test suite execution
to reuse them in the next dev mode session or test suite execution.
Within a dev mode session or test suite execution,
Quarkus will always reuse Dev Services as long as their configuration
(username, password, environment, port bindings, …) did not change.
This feature is specifically about keeping containers running
when Quarkus is not running to reuse them across runs.
|
This feature needs to be enabled explicitly in testcontainers.properties ,
may require changes to how you configure data initialization in dev mode and tests,
and may leave containers running indefinitely, forcing you to stop and remove them manually.
See this section of the documentation for more information.
|
This configuration property is set to true by default,
so it is mostly useful to disable reuse,
if you enabled it in testcontainers.properties
but only want to use it for some of your Quarkus applications.
Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_REUSE
|
boolean |
true
|
Elytron Security JDBC |
Type |
Default |
quarkus.security.jdbc.realm-name
Environment variable: QUARKUS_SECURITY_JDBC_REALM_NAME
|
string |
Quarkus
|
quarkus.security.jdbc.enabled
If the properties store is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_ENABLED
|
boolean |
false
|
quarkus.security.jdbc.principal-query.sql
The sql query to find the password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_SQL
|
string |
|
quarkus.security.jdbc.principal-query.datasource
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_DATASOURCE
|
string |
|
quarkus.security.jdbc.principal-query.clear-password-mapper.enabled
If the clear-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_CLEAR_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
quarkus.security.jdbc.principal-query.clear-password-mapper.password-index
The index (1 based numbering) of the column containing the clear password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_CLEAR_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
1
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.enabled
If the bcrypt-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.password-index
The index (1 based numbering) of the column containing the password hash
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
0
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.hash-encoding
A string referencing the password hash encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_HASH_ENCODING
|
|
base64
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.salt-index
The index (1 based numbering) of the column containing the Bcrypt salt. The default value of -1 implies that the salt is stored in the password column using the Modular Crypt Format (MCF) standard.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_SALT_INDEX
|
int |
-1
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.salt-encoding
A string referencing the salt encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_SALT_ENCODING
|
|
base64
|
quarkus.security.jdbc.principal-query.bcrypt-password-mapper.iteration-count-index
The index (1 based numbering) of the column containing the Bcrypt iteration count. The default value of -1 implies that the iteration count is stored in the password column using the Modular Crypt Format (MCF) standard.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_BCRYPT_PASSWORD_MAPPER_ITERATION_COUNT_INDEX
|
int |
-1
|
quarkus.security.jdbc.principal-query.attribute-mappings."attribute-mappings".index
The index (1 based numbering) of column to map
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__INDEX
|
int |
0
|
quarkus.security.jdbc.principal-query.attribute-mappings."attribute-mappings".to
The target attribute name
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
required |
Named queries |
Type |
Default |
quarkus.security.jdbc.principal-query."query-name".sql
The sql query to find the password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__SQL
|
string |
|
quarkus.security.jdbc.principal-query."query-name".datasource
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__DATASOURCE
|
string |
|
quarkus.security.jdbc.principal-query."query-name".attribute-mappings."attribute-mappings".index
The index (1 based numbering) of column to map
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__INDEX
|
int |
0
|
quarkus.security.jdbc.principal-query."query-name".attribute-mappings."attribute-mappings".to
The target attribute name
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
required |
quarkus.security.jdbc.principal-query."query-name".clear-password-mapper.enabled
If the clear-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__CLEAR_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
quarkus.security.jdbc.principal-query."query-name".clear-password-mapper.password-index
The index (1 based numbering) of the column containing the clear password
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__CLEAR_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
1
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.enabled
If the bcrypt-password-mapper is enabled.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_ENABLED
|
boolean |
false
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.password-index
The index (1 based numbering) of the column containing the password hash
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_PASSWORD_INDEX
|
int |
0
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.hash-encoding
A string referencing the password hash encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_HASH_ENCODING
|
|
base64
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.salt-index
The index (1 based numbering) of the column containing the Bcrypt salt. The default value of -1 implies that the salt is stored in the password column using the Modular Crypt Format (MCF) standard.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_SALT_INDEX
|
int |
-1
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.salt-encoding
A string referencing the salt encoding ("BASE64" or "HEX")
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_SALT_ENCODING
|
|
base64
|
quarkus.security.jdbc.principal-query."query-name".bcrypt-password-mapper.iteration-count-index
The index (1 based numbering) of the column containing the Bcrypt iteration count. The default value of -1 implies that the iteration count is stored in the password column using the Modular Crypt Format (MCF) standard.
Environment variable: QUARKUS_SECURITY_JDBC_PRINCIPAL_QUERY__QUERY_NAME__BCRYPT_PASSWORD_MAPPER_ITERATION_COUNT_INDEX
|
int |
-1
|
Elytron Security LDAP |
Type |
Default |
quarkus.security.ldap.enabled
The option to enable the ldap elytron module
Environment variable: QUARKUS_SECURITY_LDAP_ENABLED
|
boolean |
false
|
quarkus.security.ldap.realm-name
Environment variable: QUARKUS_SECURITY_LDAP_REALM_NAME
|
string |
Quarkus
|
quarkus.security.ldap.direct-verification
Provided credentials are verified against ldap?
Environment variable: QUARKUS_SECURITY_LDAP_DIRECT_VERIFICATION
|
boolean |
true
|
quarkus.security.ldap.dir-context.url
The url of the ldap server
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_URL
|
string |
required |
quarkus.security.ldap.dir-context.principal
The principal: user which is used to connect to ldap server (also named "bindDn")
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_PRINCIPAL
|
string |
|
quarkus.security.ldap.dir-context.password
The password which belongs to the principal (also named "bindCredential")
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_PASSWORD
|
string |
|
quarkus.security.ldap.dir-context.referral-mode
how ldap redirects are handled
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_REFERRAL_MODE
|
|
ignore
|
quarkus.security.ldap.dir-context.connect-timeout
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_CONNECT_TIMEOUT
|
Duration |
5S
|
quarkus.security.ldap.dir-context.read-timeout
Environment variable: QUARKUS_SECURITY_LDAP_DIR_CONTEXT_READ_TIMEOUT
|
Duration |
60S
|
quarkus.security.ldap.cache.enabled
If set to true, request to the LDAP server are cached
Environment variable: QUARKUS_SECURITY_LDAP_CACHE_ENABLED
|
boolean |
false
|
quarkus.security.ldap.cache.max-age
The duration that an entry can stay in the cache
Environment variable: QUARKUS_SECURITY_LDAP_CACHE_MAX_AGE
|
Duration |
60S
|
quarkus.security.ldap.cache.size
The maximum number of entries to keep in the cache
Environment variable: QUARKUS_SECURITY_LDAP_CACHE_SIZE
|
int |
100
|
quarkus.security.ldap.identity-mapping.rdn-identifier
The identifier which correlates to the provided user (also named "baseFilter")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_RDN_IDENTIFIER
|
string |
uid
|
quarkus.security.ldap.identity-mapping.search-base-dn
The dn where we look for users
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_SEARCH_BASE_DN
|
string |
required |
quarkus.security.ldap.identity-mapping.search-recursive
If the child nodes are also searched for identities
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_SEARCH_RECURSIVE
|
boolean |
false
|
quarkus.security.ldap.identity-mapping.attribute-mappings."attribute-mappings".from
The roleAttributeId from which is mapped (e.g. "cn")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FROM
|
string |
required |
quarkus.security.ldap.identity-mapping.attribute-mappings."attribute-mappings".to
The identifier whom the attribute is mapped to (in Quarkus: "groups", in WildFly this is "Roles")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__TO
|
string |
groups
|
quarkus.security.ldap.identity-mapping.attribute-mappings."attribute-mappings".filter
The filter (also named "roleFilter")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FILTER
|
string |
required |
quarkus.security.ldap.identity-mapping.attribute-mappings."attribute-mappings".filter-base-dn
The filter base dn (also named "rolesContextDn")
Environment variable: QUARKUS_SECURITY_LDAP_IDENTITY_MAPPING_ATTRIBUTE_MAPPINGS__ATTRIBUTE_MAPPINGS__FILTER_BASE_DN
|
string |
required |
Elytron Security OAuth 2.0 |
Type |
Default |
Determine if the OAuth2 extension is enabled. Enabled by default if you include the elytron-security-oauth2 dependency, so this would be used to disable it.
Environment variable: QUARKUS_OAUTH2_ENABLED
|
boolean |
true
|
quarkus.oauth2.role-claim
The claim that is used in the introspection endpoint response to load the roles.
Environment variable: QUARKUS_OAUTH2_ROLE_CLAIM
|
string |
scope
|
The OAuth2 client id used to validate the token. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_CLIENT_ID
|
string |
|
quarkus.oauth2.client-secret
The OAuth2 client secret used to validate the token. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_CLIENT_SECRET
|
string |
|
quarkus.oauth2.introspection-url
The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims. Mandatory if the extension is enabled.
Environment variable: QUARKUS_OAUTH2_INTROSPECTION_URL
|
string |
|
quarkus.oauth2.ca-cert-file
The OAuth2 server certificate file. Warning: this is not supported in native mode where the certificate must be included in the truststore used during the native image generation, see Using SSL With Native Executables.
Environment variable: QUARKUS_OAUTH2_CA_CERT_FILE
|
string |
|
Elytron Security Properties File |
Type |
Default |
quarkus.security.users.embedded.plain-text
If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_PLAIN_TEXT
|
boolean |
false
|
quarkus.security.users.embedded.algorithm
Determine which algorithm to use.
This property is ignored if plainText is true.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ALGORITHM
|
digest-md5 , digest-sha , digest-sha-256 , digest-sha-384 , digest-sha-512 , digest-sha-512-256
|
digest-md5
|
quarkus.security.users.embedded.users."users"
The realm users user1=password\nuser2=password2… mapping. See Embedded Users.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_USERS__USERS_
|
Map<String,String> |
none
|
quarkus.security.users.embedded.roles."roles"
The realm roles user1=role1,role2,…\nuser2=role1,role2,… mapping See Embedded Roles.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ROLES__ROLES_
|
Map<String,String> |
none
|
Property Files Realm Configuration |
Type |
Default |
quarkus.security.users.file.realm-name
The realm name. This is used when generating a hashed password
Environment variable: QUARKUS_SECURITY_USERS_FILE_REALM_NAME
|
string |
Quarkus
|
quarkus.security.users.file.enabled
Determine whether security via the file realm is enabled.
Environment variable: QUARKUS_SECURITY_USERS_FILE_ENABLED
|
boolean |
false
|
quarkus.security.users.file.plain-text
If the properties are stored in plain text. If this is false (the default) then it is expected that the passwords are of the form HEX( MD5( username ":" realm ":" password ) )
Environment variable: QUARKUS_SECURITY_USERS_FILE_PLAIN_TEXT
|
boolean |
false
|
quarkus.security.users.file.users
Classpath resource name of properties file containing user to password mappings. See Users.properties.
Environment variable: QUARKUS_SECURITY_USERS_FILE_USERS
|
string |
users.properties
|
quarkus.security.users.file.roles
Classpath resource name of properties file containing user to role mappings. See Roles.properties.
Environment variable: QUARKUS_SECURITY_USERS_FILE_ROLES
|
string |
roles.properties
|
Embedded Realm Configuration |
Type |
Default |
quarkus.security.users.embedded.realm-name
The realm name. This is used when generating a hashed password
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_REALM_NAME
|
string |
Quarkus
|
quarkus.security.users.embedded.enabled
Determine whether security via the embedded realm is enabled.
Environment variable: QUARKUS_SECURITY_USERS_EMBEDDED_ENABLED
|
boolean |
false
|
Flyway |
Type |
Default |
Whether Flyway is enabled during the build.
If Flyway is disabled, the Flyway beans won’t be created and Flyway won’t be usable.
Environment variable: QUARKUS_FLYWAY_ENABLED
|
boolean |
true
|
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.
Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations.
Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
Environment variable: QUARKUS_FLYWAY_LOCATIONS
|
list of string |
db/migration
|
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The org.flywaydb.core.api.callback.Callback subclass must have a no-args constructor and must not be abstract. These classes must also not have any fields that hold state (unless that state is initialized in the constructor).
Environment variable: QUARKUS_FLYWAY_CALLBACKS
|
list of string |
|
Flag to activate/deactivate Flyway for a specific datasource at runtime.
Environment variable: QUARKUS_FLYWAY_ACTIVE
|
boolean |
'true' if the datasource is active; 'false' otherwise
|
quarkus.flyway.connect-retries
The maximum number of retries when attempting to connect to the database.
After each failed attempt, Flyway will wait up to the configured connect-retries-interval duration before attempting to connect again, up to the maximum number of times specified by connectRetries.
Environment variable: QUARKUS_FLYWAY_CONNECT_RETRIES
|
int |
|
quarkus.flyway.connect-retries-interval
The maximum time between retries when attempting to connect to the database.
This will cap the interval between connect retries to the value provided.
Environment variable: QUARKUS_FLYWAY_CONNECT_RETRIES_INTERVAL
|
Duration |
120 seconds
|
quarkus.flyway.default-schema
Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default schema for the database connection.
Environment variable: QUARKUS_FLYWAY_DEFAULT_SCHEMA
|
string |
|
The JDBC URL that Flyway uses to connect to the database. Falls back to the datasource URL if not specified.
Environment variable: QUARKUS_FLYWAY_JDBC_URL
|
string |
|
The username that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource username if not specified.
Environment variable: QUARKUS_FLYWAY_USERNAME
|
string |
|
The password that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource password if not specified.
Environment variable: QUARKUS_FLYWAY_PASSWORD
|
string |
|
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table.
Environment variable: QUARKUS_FLYWAY_SCHEMAS
|
list of string |
|
The name of Flyway’s schema history table. By default (single-schema mode), the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list.
Environment variable: QUARKUS_FLYWAY_TABLE
|
string |
|
quarkus.flyway.sql-migration-prefix
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql
Environment variable: QUARKUS_FLYWAY_SQL_MIGRATION_PREFIX
|
string |
|
quarkus.flyway.repeatable-sql-migration-prefix
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql
Environment variable: QUARKUS_FLYWAY_REPEATABLE_SQL_MIGRATION_PREFIX
|
string |
|
quarkus.flyway.clean-at-start
true to execute Flyway clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_AT_START
|
boolean |
false
|
quarkus.flyway.clean-disabled
true to prevent Flyway clean operations, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_DISABLED
|
boolean |
false
|
quarkus.flyway.clean-on-validation-error
true to automatically call clean when a validation error occurs, false otherwise.
Environment variable: QUARKUS_FLYWAY_CLEAN_ON_VALIDATION_ERROR
|
boolean |
false
|
quarkus.flyway.migrate-at-start
true to execute Flyway automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_MIGRATE_AT_START
|
boolean |
false
|
quarkus.flyway.repair-at-start
true to execute a Flyway repair command when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_REPAIR_AT_START
|
boolean |
false
|
quarkus.flyway.validate-at-start
true to execute a Flyway validate command when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY_VALIDATE_AT_START
|
boolean |
false
|
quarkus.flyway.baseline-on-migrate
true to execute Flyway baseline before migrations This flag is ignored if the flyway_schema_history table exists in the current schema or if the current schema is empty. Note that this will not automatically call migrate, you must either enable baselineAtStart or programmatically call flyway.migrate().
Environment variable: QUARKUS_FLYWAY_BASELINE_ON_MIGRATE
|
boolean |
false
|
quarkus.flyway.baseline-at-start
true to execute Flyway baseline automatically when the application starts. This flag is ignored if the flyway_schema_history table exists in the current schema. This will work even if the current schema is empty.
Environment variable: QUARKUS_FLYWAY_BASELINE_AT_START
|
boolean |
false
|
quarkus.flyway.baseline-version
The initial baseline version.
Environment variable: QUARKUS_FLYWAY_BASELINE_VERSION
|
string |
|
quarkus.flyway.baseline-description
The description to tag an existing schema with when executing baseline.
Environment variable: QUARKUS_FLYWAY_BASELINE_DESCRIPTION
|
string |
|
quarkus.flyway.validate-on-migrate
Whether to automatically call validate when performing a migration.
Environment variable: QUARKUS_FLYWAY_VALIDATE_ON_MIGRATE
|
boolean |
true
|
quarkus.flyway.out-of-order
Allows migrations to be run "out of order".
Environment variable: QUARKUS_FLYWAY_OUT_OF_ORDER
|
boolean |
false
|
quarkus.flyway.ignore-missing-migrations
Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.
Environment variable: QUARKUS_FLYWAY_IGNORE_MISSING_MIGRATIONS
|
boolean |
false
|
quarkus.flyway.ignore-future-migrations
Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.
Environment variable: QUARKUS_FLYWAY_IGNORE_FUTURE_MIGRATIONS
|
boolean |
false
|
quarkus.flyway.placeholders."placeholder-key"
Sets the placeholders to replace in SQL migration scripts.
Environment variable: QUARKUS_FLYWAY_PLACEHOLDERS__PLACEHOLDER_KEY_
|
Map<String,String> |
|
quarkus.flyway.create-schemas
Whether Flyway should attempt to create the schemas specified in the schemas property
Environment variable: QUARKUS_FLYWAY_CREATE_SCHEMAS
|
boolean |
true
|
quarkus.flyway.placeholder-prefix
Prefix of every placeholder (default: ${ )
Environment variable: QUARKUS_FLYWAY_PLACEHOLDER_PREFIX
|
string |
|
quarkus.flyway.placeholder-suffix
Suffix of every placeholder (default: } )
Environment variable: QUARKUS_FLYWAY_PLACEHOLDER_SUFFIX
|
string |
|
The SQL statements to run to initialize a new database connection immediately after opening it.
Environment variable: QUARKUS_FLYWAY_INIT_SQL
|
string |
|
quarkus.flyway.validate-migration-naming
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected.
Environment variable: QUARKUS_FLYWAY_VALIDATE_MIGRATION_NAMING
|
boolean |
false
|
quarkus.flyway.ignore-migration-patterns
Environment variable: QUARKUS_FLYWAY_IGNORE_MIGRATION_PATTERNS
|
list of string |
|
Named datasources |
Type |
Default |
quarkus.flyway."datasource-name".locations
Comma-separated list of locations to scan recursively for migrations. The location type is determined by its prefix.
Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both SQL and Java-based migrations.
Locations starting with filesystem: point to a directory on the filesystem, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__LOCATIONS
|
list of string |
db/migration
|
quarkus.flyway."datasource-name".callbacks
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The org.flywaydb.core.api.callback.Callback subclass must have a no-args constructor and must not be abstract. These classes must also not have any fields that hold state (unless that state is initialized in the constructor).
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CALLBACKS
|
list of string |
|
quarkus.flyway."datasource-name".active
Flag to activate/deactivate Flyway for a specific datasource at runtime.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__ACTIVE
|
boolean |
'true' if the datasource is active; 'false' otherwise
|
quarkus.flyway."datasource-name".connect-retries
The maximum number of retries when attempting to connect to the database.
After each failed attempt, Flyway will wait up to the configured connect-retries-interval duration before attempting to connect again, up to the maximum number of times specified by connectRetries.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CONNECT_RETRIES
|
int |
|
quarkus.flyway."datasource-name".connect-retries-interval
The maximum time between retries when attempting to connect to the database.
This will cap the interval between connect retries to the value provided.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CONNECT_RETRIES_INTERVAL
|
Duration |
120 seconds
|
quarkus.flyway."datasource-name".default-schema
Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default schema for the database connection.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__DEFAULT_SCHEMA
|
string |
|
quarkus.flyway."datasource-name".jdbc-url
The JDBC URL that Flyway uses to connect to the database. Falls back to the datasource URL if not specified.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__JDBC_URL
|
string |
|
quarkus.flyway."datasource-name".username
The username that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource username if not specified.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__USERNAME
|
string |
|
quarkus.flyway."datasource-name".password
The password that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource password if not specified.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__PASSWORD
|
string |
|
quarkus.flyway."datasource-name".schemas
Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__SCHEMAS
|
list of string |
|
quarkus.flyway."datasource-name".table
The name of Flyway’s schema history table. By default (single-schema mode), the schema history table is placed in the default schema for the connection provided by the datasource. When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of the list.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__TABLE
|
string |
|
quarkus.flyway."datasource-name".sql-migration-prefix
The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__SQL_MIGRATION_PREFIX
|
string |
|
quarkus.flyway."datasource-name".repeatable-sql-migration-prefix
The file name prefix for repeatable SQL migrations. Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__REPEATABLE_SQL_MIGRATION_PREFIX
|
string |
|
quarkus.flyway."datasource-name".clean-at-start
true to execute Flyway clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CLEAN_AT_START
|
boolean |
false
|
quarkus.flyway."datasource-name".clean-disabled
true to prevent Flyway clean operations, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CLEAN_DISABLED
|
boolean |
false
|
quarkus.flyway."datasource-name".clean-on-validation-error
true to automatically call clean when a validation error occurs, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CLEAN_ON_VALIDATION_ERROR
|
boolean |
false
|
quarkus.flyway."datasource-name".migrate-at-start
true to execute Flyway automatically when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__MIGRATE_AT_START
|
boolean |
false
|
quarkus.flyway."datasource-name".repair-at-start
true to execute a Flyway repair command when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__REPAIR_AT_START
|
boolean |
false
|
quarkus.flyway."datasource-name".validate-at-start
true to execute a Flyway validate command when the application starts, false otherwise.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__VALIDATE_AT_START
|
boolean |
false
|
quarkus.flyway."datasource-name".baseline-on-migrate
true to execute Flyway baseline before migrations This flag is ignored if the flyway_schema_history table exists in the current schema or if the current schema is empty. Note that this will not automatically call migrate, you must either enable baselineAtStart or programmatically call flyway.migrate().
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__BASELINE_ON_MIGRATE
|
boolean |
false
|
quarkus.flyway."datasource-name".baseline-at-start
true to execute Flyway baseline automatically when the application starts. This flag is ignored if the flyway_schema_history table exists in the current schema. This will work even if the current schema is empty.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__BASELINE_AT_START
|
boolean |
false
|
quarkus.flyway."datasource-name".baseline-version
The initial baseline version.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__BASELINE_VERSION
|
string |
|
quarkus.flyway."datasource-name".baseline-description
The description to tag an existing schema with when executing baseline.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__BASELINE_DESCRIPTION
|
string |
|
quarkus.flyway."datasource-name".validate-on-migrate
Whether to automatically call validate when performing a migration.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__VALIDATE_ON_MIGRATE
|
boolean |
true
|
quarkus.flyway."datasource-name".out-of-order
Allows migrations to be run "out of order".
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__OUT_OF_ORDER
|
boolean |
false
|
quarkus.flyway."datasource-name".ignore-missing-migrations
Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__IGNORE_MISSING_MIGRATIONS
|
boolean |
false
|
quarkus.flyway."datasource-name".ignore-future-migrations
Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__IGNORE_FUTURE_MIGRATIONS
|
boolean |
false
|
quarkus.flyway."datasource-name".placeholders."placeholder-key"
Sets the placeholders to replace in SQL migration scripts.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__PLACEHOLDERS__PLACEHOLDER_KEY_
|
Map<String,String> |
|
quarkus.flyway."datasource-name".create-schemas
Whether Flyway should attempt to create the schemas specified in the schemas property
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__CREATE_SCHEMAS
|
boolean |
true
|
quarkus.flyway."datasource-name".placeholder-prefix
Prefix of every placeholder (default: ${ )
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__PLACEHOLDER_PREFIX
|
string |
|
quarkus.flyway."datasource-name".placeholder-suffix
Suffix of every placeholder (default: } )
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__PLACEHOLDER_SUFFIX
|
string |
|
quarkus.flyway."datasource-name".init-sql
The SQL statements to run to initialize a new database connection immediately after opening it.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__INIT_SQL
|
string |
|
quarkus.flyway."datasource-name".validate-migration-naming
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected.
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__VALIDATE_MIGRATION_NAMING
|
boolean |
false
|
quarkus.flyway."datasource-name".ignore-migration-patterns
Environment variable: QUARKUS_FLYWAY__DATASOURCE_NAME__IGNORE_MIGRATION_PATTERNS
|
list of string |
|
Funqy AWS Lambda Binding |
Type |
Default |
quarkus.funqy.amazon-lambda.advanced-event-handling.enabled
If advanced event handling should be enabled
Environment variable: QUARKUS_FUNQY_AMAZON_LAMBDA_ADVANCED_EVENT_HANDLING_ENABLED
|
boolean |
true
|
quarkus.funqy.amazon-lambda.advanced-event-handling.sqs.report-batch-item-failures
Allows functions to return partially successful responses for a batch of event records.
Environment variable: QUARKUS_FUNQY_AMAZON_LAMBDA_ADVANCED_EVENT_HANDLING_SQS_REPORT_BATCH_ITEM_FAILURES
|
boolean |
true
|
quarkus.funqy.amazon-lambda.advanced-event-handling.kinesis.report-batch-item-failures
Allows functions to return partially successful responses for a batch of event records.
Environment variable: QUARKUS_FUNQY_AMAZON_LAMBDA_ADVANCED_EVENT_HANDLING_KINESIS_REPORT_BATCH_ITEM_FAILURES
|
boolean |
true
|
quarkus.funqy.amazon-lambda.advanced-event-handling.dynamo-db.report-batch-item-failures
Allows functions to return partially successful responses for a batch of event records.
Environment variable: QUARKUS_FUNQY_AMAZON_LAMBDA_ADVANCED_EVENT_HANDLING_DYNAMO_DB_REPORT_BATCH_ITEM_FAILURES
|
boolean |
true
|
Funqy Knative Events Binding |
Type |
Default |
quarkus.funqy.knative-events.mapping."mapping".trigger
Cloud Event type (ce-type) that triggers this function. Default value is function name. This config item is only required when there is more than one function defined within the deployment. The ce-type is not looked at if there is only one function in the deployment. The message will just be dispatched to that function. This allows you to change the knative trigger binding without having to change the configuration of the quarkus deployment.
Environment variable: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__TRIGGER
|
string |
|
quarkus.funqy.knative-events.mapping."mapping".response-type
If function has response output, then what is the Cloud Event type (ce-type)? This will default to {function}.output
Environment variable: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__RESPONSE_TYPE
|
string |
|
quarkus.funqy.knative-events.mapping."mapping".response-source
If function has response output, then what is the Cloud Event source (ce-source)? This will default to the function name
Environment variable: QUARKUS_FUNQY_KNATIVE_EVENTS_MAPPING__MAPPING__RESPONSE_SOURCE
|
string |
|
Funqy Server Common |
Type |
Default |
The function to export. If there is more than one function defined for this deployment, then you must set this variable. If there is only a single function, you do not have to set this config item.
Environment variable: QUARKUS_FUNQY_EXPORT
|
string |
|
Google Cloud Functions |
Type |
Default |
quarkus.google-cloud-functions.function
The function name. Function names are specified on function classes using the @jakarta.inject.Named annotation. If this name is unspecified and there is exactly one unnamed function then this unnamed function will be used. If there is only a single named function and the name is unspecified then the named function will be used. These rules apply for each function implementation (HttpFunction, BackgroundFunction, RawBackgroundFunction).
Environment variable: QUARKUS_GOOGLE_CLOUD_FUNCTIONS_FUNCTION
|
string |
|
gRPC |
Type |
Default |
quarkus.grpc.server.health.enabled
Whether a health check on gRPC status is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_GRPC_SERVER_HEALTH_ENABLED
|
boolean |
true
|
quarkus.grpc.server.grpc-health.enabled
Whether the gRPC health check is exposed.
Environment variable: QUARKUS_GRPC_SERVER_GRPC_HEALTH_ENABLED
|
boolean |
true
|
Configuration gRPC dev mode |
Type |
Default |
quarkus.grpc.dev-mode.force-server-start
Start gRPC server in dev mode even if no gRPC services are implemented. By default set to true to ease incremental development of new services using dev mode.
Environment variable: QUARKUS_GRPC_DEV_MODE_FORCE_SERVER_START
|
boolean |
true
|
Configures the gRPC clients |
Type |
Default |
quarkus.grpc.clients."client-name".use-quarkus-grpc-client
Use new Vert.x gRPC client support. By default, we still use previous Java gRPC support.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USE_QUARKUS_GRPC_CLIENT
|
boolean |
false
|
Configure XDS usage, if enabled |
Type |
Default |
quarkus.grpc.clients."client-name".xds.enabled
Explicitly enable use of XDS.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_ENABLED
|
boolean |
false
|
quarkus.grpc.clients."client-name".xds.secure
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_SECURE
|
boolean |
false
|
quarkus.grpc.clients."client-name".xds.target
Optional explicit target.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__XDS_TARGET
|
string |
|
quarkus.grpc.clients."client-name".in-process.enabled
Explicitly enable use of in-process.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_ENABLED
|
boolean |
false
|
quarkus.grpc.clients."client-name".in-process.name
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IN_PROCESS_NAME
|
string |
quarkus-grpc
|
quarkus.grpc.clients."client-name".stork.threads
Number of threads on a delayed gRPC ClientCall
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_THREADS
|
int |
10
|
quarkus.grpc.clients."client-name".stork.deadline
Deadline in milliseconds of delayed gRPC call
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DEADLINE
|
long |
5000
|
quarkus.grpc.clients."client-name".stork.retries
Number of retries on a gRPC ClientCall
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_RETRIES
|
int |
3
|
quarkus.grpc.clients."client-name".stork.delay
Initial delay in seconds on refresh check
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_DELAY
|
long |
60
|
quarkus.grpc.clients."client-name".stork.period
Refresh period in seconds
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__STORK_PERIOD
|
long |
120
|
quarkus.grpc.clients."client-name".port
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PORT
|
int |
9000
|
quarkus.grpc.clients."client-name".test-port
The gRPC service test port.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TEST_PORT
|
int |
|
quarkus.grpc.clients."client-name".host
The host name / IP on which the service is exposed.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__HOST
|
string |
localhost
|
quarkus.grpc.clients."client-name".ssl.certificate
The classpath path or file path to a server certificate or certificate chain in PEM format.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_CERTIFICATE
|
path |
|
quarkus.grpc.clients."client-name".ssl.key
The classpath path or file path to the corresponding certificate private key file in PEM format.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_KEY
|
path |
|
quarkus.grpc.clients."client-name".ssl.trust-store
An optional trust store which holds the certificate information of the certificates to trust The trust store can be either on classpath or in an external file.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__SSL_TRUST_STORE
|
path |
|
quarkus.grpc.clients."client-name".tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration is set, and quarkus.tls.* is not configured, then, quarkus.grpc.clients.$client-name.tls will be used.
Important: This is only supported when using the Quarkus (Vert.x-based) gRPC client.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_CONFIGURATION_NAME
|
string |
|
quarkus.grpc.clients."client-name".tls.enabled
Whether SSL/TLS is enabled.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_ENABLED
|
boolean |
false
|
quarkus.grpc.clients."client-name".tls.trust-all
Enable trusting all certificates. Disabled by default.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_ALL
|
boolean |
false
|
quarkus.grpc.clients."client-name".tls.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.grpc.clients."client-name".tls.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.grpc.clients."client-name".tls.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.grpc.clients."client-name".tls.trust-certificate-p12.path
Path to the key file (PFX format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PATH
|
string |
|
quarkus.grpc.clients."client-name".tls.trust-certificate-p12.password
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_TRUST_CERTIFICATE_P12_PASSWORD
|
string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-p12.path
Path to the key file (PFX format).
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PATH
|
string |
|
quarkus.grpc.clients."client-name".tls.key-certificate-p12.password
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_KEY_CERTIFICATE_P12_PASSWORD
|
string |
|
quarkus.grpc.clients."client-name".tls.verify-hostname
Whether hostname should be verified in the SSL/TLS handshake.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__TLS_VERIFY_HOSTNAME
|
boolean |
true
|
quarkus.grpc.clients."client-name".name-resolver
Use a name resolver. Defaults to dns. If set to "stork", host will be treated as SmallRye Stork service name
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NAME_RESOLVER
|
string |
dns
|
quarkus.grpc.clients."client-name".plain-text
Whether plain-text should be used instead of TLS . Enabled by default, except if TLS/SSL is configured. In this case, plain-text is disabled.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PLAIN_TEXT
|
boolean |
|
quarkus.grpc.clients."client-name".keep-alive-time
The duration after which a keep alive ping is sent.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIME
|
Duration |
|
quarkus.grpc.clients."client-name".flow-control-window
The flow control window in bytes. Default is 1MiB.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__FLOW_CONTROL_WINDOW
|
int |
|
quarkus.grpc.clients."client-name".idle-timeout
The duration without ongoing RPCs before going to idle mode.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__IDLE_TIMEOUT
|
Duration |
|
quarkus.grpc.clients."client-name".keep-alive-timeout
The amount of time the sender of a keep alive ping waits for an acknowledgement.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_TIMEOUT
|
Duration |
|
quarkus.grpc.clients."client-name".keep-alive-without-calls
Whether keep-alive will be performed when there are no outstanding RPC on a connection.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__KEEP_ALIVE_WITHOUT_CALLS
|
boolean |
false
|
quarkus.grpc.clients."client-name".max-hedged-attempts
The max number of hedged attempts.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_HEDGED_ATTEMPTS
|
int |
5
|
quarkus.grpc.clients."client-name".max-retry-attempts
The max number of retry attempts. Retry must be explicitly enabled.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_RETRY_ATTEMPTS
|
int |
5
|
quarkus.grpc.clients."client-name".max-trace-events
The maximum number of channel trace events to keep in the tracer for each channel or sub-channel.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_TRACE_EVENTS
|
int |
|
quarkus.grpc.clients."client-name".max-inbound-message-size
The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_MESSAGE_SIZE
|
int |
|
quarkus.grpc.clients."client-name".max-inbound-metadata-size
The maximum size of metadata allowed to be received (in bytes). Default is 8192B.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__MAX_INBOUND_METADATA_SIZE
|
int |
|
quarkus.grpc.clients."client-name".negotiation-type
The negotiation type for the HTTP/2 connection. Accepted values are: TLS , PLAINTEXT_UPGRADE , PLAINTEXT
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__NEGOTIATION_TYPE
|
string |
TLS
|
quarkus.grpc.clients."client-name".override-authority
Overrides the authority used with TLS and HTTP virtual hosting.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__OVERRIDE_AUTHORITY
|
string |
|
quarkus.grpc.clients."client-name".per-rpc-buffer-limit
The per RPC buffer limit in bytes used for retry.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__PER_RPC_BUFFER_LIMIT
|
long |
|
quarkus.grpc.clients."client-name".retry
Whether retry is enabled. Note that retry is disabled by default.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY
|
boolean |
false
|
quarkus.grpc.clients."client-name".retry-buffer-size
The retry buffer size in bytes.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__RETRY_BUFFER_SIZE
|
long |
|
quarkus.grpc.clients."client-name".user-agent
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__USER_AGENT
|
string |
|
quarkus.grpc.clients."client-name".load-balancing-policy
Use a custom load balancing policy. Accepted values are: pick_first , round_robin , grpclb . This value is ignored if name-resolver is set to 'stork'.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__LOAD_BALANCING_POLICY
|
string |
pick_first
|
quarkus.grpc.clients."client-name".compression
The compression to use for each call. The accepted values are gzip and identity .
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__COMPRESSION
|
string |
|
quarkus.grpc.clients."client-name".deadline
The deadline used for each call.
Environment variable: QUARKUS_GRPC_CLIENTS__CLIENT_NAME__DEADLINE
|
Duration |
|
Configure the gRPC server |
Type |
Default |
quarkus.grpc.server.use-separate-server
Do we use separate HTTP server to serve gRPC requests. Set this to false if you want to use new Vert.x gRPC support, which uses existing Vert.x HTTP server.
Environment variable: QUARKUS_GRPC_SERVER_USE_SEPARATE_SERVER
|
boolean |
true
|
Configure XDS usage, if enabled |
Type |
Default |
quarkus.grpc.server.xds.enabled
Explicitly enable use of XDS.
Environment variable: QUARKUS_GRPC_SERVER_XDS_ENABLED
|
boolean |
false
|
quarkus.grpc.server.xds.secure
Environment variable: QUARKUS_GRPC_SERVER_XDS_SECURE
|
boolean |
false
|
quarkus.grpc.server.in-process.enabled
Explicitly enable use of in-process.
Environment variable: QUARKUS_GRPC_SERVER_IN_PROCESS_ENABLED
|
boolean |
false
|
quarkus.grpc.server.in-process.name
Environment variable: QUARKUS_GRPC_SERVER_IN_PROCESS_NAME
|
string |
quarkus-grpc
|
Environment variable: QUARKUS_GRPC_SERVER_PORT
|
int |
9000
|
quarkus.grpc.server.test-port
The gRPC Server port used for tests.
Environment variable: QUARKUS_GRPC_SERVER_TEST_PORT
|
int |
9001
|
Environment variable: QUARKUS_GRPC_SERVER_HOST
|
string |
0.0.0.0
|
quarkus.grpc.server.handshake-timeout
The gRPC handshake timeout.
Environment variable: QUARKUS_GRPC_SERVER_HANDSHAKE_TIMEOUT
|
Duration |
|
quarkus.grpc.server.max-inbound-message-size
The max inbound message size in bytes.
Environment variable: QUARKUS_GRPC_SERVER_MAX_INBOUND_MESSAGE_SIZE
|
int |
|
quarkus.grpc.server.max-inbound-metadata-size
The max inbound metadata size in bytes
Environment variable: QUARKUS_GRPC_SERVER_MAX_INBOUND_METADATA_SIZE
|
int |
|
quarkus.grpc.server.ssl.certificate
The classpath path or file path to a server certificate or certificate chain in PEM format.
Environment variable: QUARKUS_GRPC_SERVER_SSL_CERTIFICATE
|
path |
|
quarkus.grpc.server.ssl.key
The classpath path or file path to the corresponding certificate private key file in PEM format.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY
|
path |
|
quarkus.grpc.server.ssl.key-store
An optional keystore that holds the certificate information instead of specifying separate files. The keystore can be either on classpath or an external file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY_STORE
|
path |
|
quarkus.grpc.server.ssl.key-store-type
An optional parameter to specify the type of the keystore file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY_STORE_TYPE
|
string |
|
quarkus.grpc.server.ssl.key-store-password
A parameter to specify the password of the keystore file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY_STORE_PASSWORD
|
string |
|
quarkus.grpc.server.ssl.key-store-alias
A parameter to specify the alias of the keystore file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS
|
string |
|
quarkus.grpc.server.ssl.key-store-alias-password
A parameter to specify the alias password of the keystore file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_KEY_STORE_ALIAS_PASSWORD
|
string |
|
quarkus.grpc.server.ssl.trust-store
An optional trust store which holds the certificate information of the certificates to trust
The trust store can be either on classpath or an external file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_TRUST_STORE
|
path |
|
quarkus.grpc.server.ssl.trust-store-type
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_TYPE
|
string |
|
quarkus.grpc.server.ssl.trust-store-password
A parameter to specify the password of the trust store file.
Environment variable: QUARKUS_GRPC_SERVER_SSL_TRUST_STORE_PASSWORD
|
string |
|
quarkus.grpc.server.ssl.cipher-suites
The cipher suites to use. If none is given, a reasonable default is selected.
Environment variable: QUARKUS_GRPC_SERVER_SSL_CIPHER_SUITES
|
list of string |
|
quarkus.grpc.server.ssl.protocols
Sets the ordered list of enabled SSL/TLS protocols.
If not set, it defaults to "TLSv1.3, TLSv1.2" . The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 . To only enable TLSv1.3 , set the value to to "TLSv1.3" .
Note that setting an empty list, and enabling SSL/TLS is invalid. You must at least have one protocol.
Environment variable: QUARKUS_GRPC_SERVER_SSL_PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
quarkus.grpc.server.ssl.client-auth
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED
Environment variable: QUARKUS_GRPC_SERVER_SSL_CLIENT_AUTH
|
|
none
|
quarkus.grpc.server.plain-text
Disables SSL, and uses plain text instead. If disabled, configure the ssl configuration.
Environment variable: QUARKUS_GRPC_SERVER_PLAIN_TEXT
|
boolean |
true
|
Whether ALPN should be used.
Environment variable: QUARKUS_GRPC_SERVER_ALPN
|
boolean |
true
|
quarkus.grpc.server.transport-security.certificate
The path to the certificate file.
Environment variable: QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_CERTIFICATE
|
string |
|
quarkus.grpc.server.transport-security.key
The path to the private key file.
Environment variable: QUARKUS_GRPC_SERVER_TRANSPORT_SECURITY_KEY
|
string |
|
quarkus.grpc.server.enable-reflection-service
Enables the gRPC Reflection Service. By default, the reflection service is only exposed in dev mode. This setting allows overriding this choice and enable the reflection service every time.
Environment variable: QUARKUS_GRPC_SERVER_ENABLE_REFLECTION_SERVICE
|
boolean |
false
|
quarkus.grpc.server.instances
Number of gRPC server verticle instances. This is useful for scaling easily across multiple cores. The number should not exceed the amount of event loops.
Environment variable: QUARKUS_GRPC_SERVER_INSTANCES
|
int |
1
|
quarkus.grpc.server.netty.keep-alive-time
Sets a custom keep-alive duration. This configures the time before sending a keepalive ping when there is no read activity.
Environment variable: QUARKUS_GRPC_SERVER_NETTY_KEEP_ALIVE_TIME
|
Duration |
|
quarkus.grpc.server.netty.permit-keep-alive-time
Sets a custom permit-keep-alive duration. This configures the most aggressive keep-alive time clients are permitted to configure. The server will try to detect clients exceeding this rate and when detected will forcefully close the connection.
Environment variable: QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_TIME
|
Duration |
|
quarkus.grpc.server.netty.permit-keep-alive-without-calls
Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection.
Environment variable: QUARKUS_GRPC_SERVER_NETTY_PERMIT_KEEP_ALIVE_WITHOUT_CALLS
|
boolean |
|
quarkus.grpc.server.compression
gRPC compression, e.g. "gzip"
Environment variable: QUARKUS_GRPC_SERVER_COMPRESSION
|
string |
|
quarkus.grpc-client.stork-proactive-connections
If set to true, and a Stork load balancer is used, connections with all available service instances will be requested proactively. This means better load balancing at the cost of having multiple active connections.
Environment variable: QUARKUS_GRPC_CLIENT_STORK_PROACTIVE_CONNECTIONS
|
boolean |
true
|
quarkus.generate-code.grpc.scan-for-proto
gRPC code generation can scan dependencies of the application for proto files to generate Java stubs from. This property sets the scope of the dependencies to scan. Applicable values:
-
none - default - don’t scan dependencies
-
a comma separated list of groupId:artifactId coordinates to scan
-
all - scan all dependencies
Environment variable: QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_PROTO
|
string |
none
|
quarkus.generate-code.grpc.scan-for-imports
Specify the dependencies that are allowed to have proto files that can be imported by this application’s protos Applicable values:
-
none - default - don’t scan dependencies
-
a comma separated list of groupId:artifactId coordinates to scan
-
all - scan all dependencies By default, com.google.protobuf:protobuf-java.
Environment variable: QUARKUS_GENERATE_CODE_GRPC_SCAN_FOR_IMPORTS
|
string |
com.google.protobuf:protobuf-java
|
Hibernate Envers |
Type |
Default |
quarkus.hibernate-envers.enabled
Whether Hibernate Envers is enabled <strong>during the build</strong>.
If Hibernate Envers is disabled during the build, all processing related to Hibernate Envers will be skipped,
and the audit entities will not be added to the Hibernate ORM metamodel
nor to the database schema that Hibernate ORM generates,
but it will not be possible to use Hibernate Envers at runtime:
quarkus.hibernate-envers.active will default to false and setting it to true will lead to an error.
Environment variable: QUARKUS_HIBERNATE_ENVERS_ENABLED
|
boolean |
true
|
quarkus.hibernate-envers.active
quarkus.hibernate-envers."persistence-unit-name".active
Whether Hibernate Envers should be active for this persistence unit at runtime.
If Hibernate Envers is not active, the audit entities will still be added to the Hibernate ORM metamodel
and to the database schema that Hibernate ORM generates:
you would need to disable Hibernate Envers at build time (i.e. set quarkus.hibernate-envers.enabled to false )
in order to avoid that.
However, when Hibernate Envers is not active, it will not process entity change events
nor create new versions of entities.
and accessing the AuditReader through AuditReaderFactory will not be possible.
Note that if Hibernate Envers is disabled (i.e. quarkus.hibernate-envers.enabled is set to false ),
it won’t be active for any persistence unit, and setting this property to true will fail.
Environment variable: QUARKUS_HIBERNATE_ENVERS_ACTIVE
|
boolean |
'true' if Hibernate ORM is enabled; 'false' otherwise
|
quarkus.hibernate-envers.store-data-at-delete
quarkus.hibernate-envers."persistence-unit-name".store-data-at-delete
Enable store_data_at_delete feature. Maps to org.hibernate.envers.configuration.EnversSettings#STORE_DATA_AT_DELETE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_STORE_DATA_AT_DELETE
|
boolean |
false
|
quarkus.hibernate-envers.audit-table-suffix
quarkus.hibernate-envers."persistence-unit-name".audit-table-suffix
Defines a suffix for historical data table. Defaults to _AUD . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_TABLE_SUFFIX .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_TABLE_SUFFIX
|
string |
_AUD
|
quarkus.hibernate-envers.audit-table-prefix
quarkus.hibernate-envers."persistence-unit-name".audit-table-prefix
Defines a prefix for historical data table. Default is the empty string. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_TABLE_PREFIX .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_TABLE_PREFIX
|
string |
|
quarkus.hibernate-envers.revision-field-name
quarkus.hibernate-envers."persistence-unit-name".revision-field-name
Revision field name. Defaults to REV . Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_FIELD_NAME
|
string |
REV
|
quarkus.hibernate-envers.revision-type-field-name
quarkus.hibernate-envers."persistence-unit-name".revision-type-field-name
Revision type field name. Defaults to REVTYPE . Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_TYPE_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_TYPE_FIELD_NAME
|
string |
REVTYPE
|
quarkus.hibernate-envers.revision-on-collection-change
quarkus.hibernate-envers."persistence-unit-name".revision-on-collection-change
Enable the revision_on_collection_change feature. Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_ON_COLLECTION_CHANGE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_ON_COLLECTION_CHANGE
|
boolean |
true
|
quarkus.hibernate-envers.do-not-audit-optimistic-locking-field
quarkus.hibernate-envers."persistence-unit-name".do-not-audit-optimistic-locking-field
Enable the do_not_audit_optimistic_locking_field feature. Maps to org.hibernate.envers.configuration.EnversSettings#DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DO_NOT_AUDIT_OPTIMISTIC_LOCKING_FIELD
|
boolean |
true
|
quarkus.hibernate-envers.default-schema
quarkus.hibernate-envers."persistence-unit-name".default-schema
Defines the default schema of where audit tables are to be created. Maps to org.hibernate.envers.configuration.EnversSettings#DEFAULT_SCHEMA .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DEFAULT_SCHEMA
|
string |
|
quarkus.hibernate-envers.default-catalog
quarkus.hibernate-envers."persistence-unit-name".default-catalog
Defines the default catalog of where audit tables are to be created. Maps to org.hibernate.envers.configuration.EnversSettings#DEFAULT_CATALOG .
Environment variable: QUARKUS_HIBERNATE_ENVERS_DEFAULT_CATALOG
|
string |
|
quarkus.hibernate-envers.track-entities-changed-in-revision
quarkus.hibernate-envers."persistence-unit-name".track-entities-changed-in-revision
Enables the track_entities_changed_in_revision feature. Maps to org.hibernate.envers.configuration.EnversSettings#TRACK_ENTITIES_CHANGED_IN_REVISION .
Environment variable: QUARKUS_HIBERNATE_ENVERS_TRACK_ENTITIES_CHANGED_IN_REVISION
|
boolean |
false
|
quarkus.hibernate-envers.use-revision-entity-with-native-id
quarkus.hibernate-envers."persistence-unit-name".use-revision-entity-with-native-id
Enables the use_revision_entity_with_native_id feature. Maps to org.hibernate.envers.configuration.EnversSettings#USE_REVISION_ENTITY_WITH_NATIVE_ID .
Environment variable: QUARKUS_HIBERNATE_ENVERS_USE_REVISION_ENTITY_WITH_NATIVE_ID
|
boolean |
true
|
quarkus.hibernate-envers.global-with-modified-flag
quarkus.hibernate-envers."persistence-unit-name".global-with-modified-flag
Enables the global_with_modified_flag feature. Maps to org.hibernate.envers.configuration.EnversSettings#GLOBAL_WITH_MODIFIED_FLAG .
Environment variable: QUARKUS_HIBERNATE_ENVERS_GLOBAL_WITH_MODIFIED_FLAG
|
boolean |
false
|
quarkus.hibernate-envers.modified-flag-suffix
quarkus.hibernate-envers."persistence-unit-name".modified-flag-suffix
Defines the suffix to be used for modified flag columns. Defaults to _MOD . Maps to org.hibernate.envers.configuration.EnversSettings#MODIFIED_FLAG_SUFFIX
Environment variable: QUARKUS_HIBERNATE_ENVERS_MODIFIED_FLAG_SUFFIX
|
string |
_MOD
|
quarkus.hibernate-envers.revision-listener
quarkus.hibernate-envers."persistence-unit-name".revision-listener
Defines the fully qualified class name of a user defined revision listener. Maps to org.hibernate.envers.configuration.EnversSettings#REVISION_LISTENER .
Environment variable: QUARKUS_HIBERNATE_ENVERS_REVISION_LISTENER
|
string |
|
quarkus.hibernate-envers.audit-strategy
quarkus.hibernate-envers."persistence-unit-name".audit-strategy
Defines the fully qualified class name of the audit strategy to be used. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY
|
string |
org.hibernate.envers.strategy.DefaultAuditStrategy
|
quarkus.hibernate-envers.original-id-prop-name
quarkus.hibernate-envers."persistence-unit-name".original-id-prop-name
Defines the property name for the audit entity’s composite primary key. Defaults to originalId . Maps to org.hibernate.envers.configuration.EnversSettings#ORIGINAL_ID_PROP_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_ORIGINAL_ID_PROP_NAME
|
string |
originalId
|
quarkus.hibernate-envers.audit-strategy-validity-end-rev-field-name
quarkus.hibernate-envers."persistence-unit-name".audit-strategy-validity-end-rev-field-name
Defines the column name that holds the end revision number in audit entities. Defaults to REVEND . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_END_REV_FIELD_NAME
|
string |
REVEND
|
quarkus.hibernate-envers.audit-strategy-validity-store-revend-timestamp
quarkus.hibernate-envers."persistence-unit-name".audit-strategy-validity-store-revend-timestamp
Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_STORE_REVEND_TIMESTAMP
|
boolean |
false
|
quarkus.hibernate-envers.audit-strategy-validity-revend-timestamp-field-name
quarkus.hibernate-envers."persistence-unit-name".audit-strategy-validity-revend-timestamp-field-name
Defines the column name of the revision end timestamp in the audit tables. Defaults to REVEND_TSTMP . Maps to org.hibernate.envers.configuration.EnversSettings#AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_AUDIT_STRATEGY_VALIDITY_REVEND_TIMESTAMP_FIELD_NAME
|
string |
REVEND_TSTMP
|
quarkus.hibernate-envers.embeddable-set-ordinal-field-name
quarkus.hibernate-envers."persistence-unit-name".embeddable-set-ordinal-field-name
Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to SETORDINAL . Maps to org.hibernate.envers.configuration.EnversSettings#EMBEDDABLE_SET_ORDINAL_FIELD_NAME .
Environment variable: QUARKUS_HIBERNATE_ENVERS_EMBEDDABLE_SET_ORDINAL_FIELD_NAME
|
string |
SETORDINAL
|
quarkus.hibernate-envers.allow-identifier-reuse
quarkus.hibernate-envers."persistence-unit-name".allow-identifier-reuse
Enables the allow_identifier_reuse feature. Maps to org.hibernate.envers.configuration.EnversSettings#ALLOW_IDENTIFIER_REUSE .
Environment variable: QUARKUS_HIBERNATE_ENVERS_ALLOW_IDENTIFIER_REUSE
|
boolean |
false
|
quarkus.hibernate-envers.modified-column-naming-strategy
quarkus.hibernate-envers."persistence-unit-name".modified-column-naming-strategy
Defines the naming strategy to be used for modified columns. Defaults to org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy . Maps to org.hibernate.envers.configuration.EnversSettings#MODIFIED_COLUMN_NAMING_STRATEGY .
Environment variable: QUARKUS_HIBERNATE_ENVERS_MODIFIED_COLUMN_NAMING_STRATEGY
|
string |
org.hibernate.envers.boot.internal.LegacyModifiedColumnNamingStrategy
|
Hibernate ORM |
Type |
Default |
quarkus.hibernate-orm.enabled
Whether Hibernate ORM is enabled during the build.
If Hibernate ORM is disabled during the build, all processing related to Hibernate ORM will be skipped,
but it will not be possible to activate Hibernate ORM at runtime:
quarkus.hibernate-orm.active will default to false and setting it to true will lead to an error.
Environment variable: QUARKUS_HIBERNATE_ORM_ENABLED
|
boolean |
true
|
quarkus.hibernate-orm.persistence-xml.ignore
If true , Quarkus will ignore any persistence.xml file in the classpath and rely exclusively on the Quarkus configuration.
Environment variable: QUARKUS_HIBERNATE_ORM_PERSISTENCE_XML_IGNORE
|
boolean |
false
|
quarkus.hibernate-orm.statistics
Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false.
Environment variable: QUARKUS_HIBERNATE_ORM_STATISTICS
|
boolean |
|
quarkus.hibernate-orm.log-session-metrics
Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled (quarkus.hibernate-orm.statistics ). The default is false (which means both statistics and log-session-metrics need to be enabled for the session metrics to appear in the log).
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_SESSION_METRICS
|
boolean |
|
quarkus.hibernate-orm.metrics.enabled
Whether metrics are published if a metrics extension is enabled.
Environment variable: QUARKUS_HIBERNATE_ORM_METRICS_ENABLED
|
boolean |
false
|
quarkus.hibernate-orm.datasource
quarkus.hibernate-orm."persistence-unit-name".datasource
The name of the datasource which this persistence unit uses.
If undefined, it will use the default datasource.
Environment variable: QUARKUS_HIBERNATE_ORM_DATASOURCE
|
string |
|
quarkus.hibernate-orm.packages
quarkus.hibernate-orm."persistence-unit-name".packages
The packages in which the entities affected to this persistence unit are located.
Environment variable: QUARKUS_HIBERNATE_ORM_PACKAGES
|
list of string |
|
quarkus.hibernate-orm.sql-load-script
quarkus.hibernate-orm."persistence-unit-name".sql-load-script
Paths to files containing the SQL statements to execute when Hibernate ORM starts.
The files are retrieved from the classpath resources,
so they must be located in the resources directory (e.g. src/main/resources ).
The default value for this setting differs depending on the Quarkus launch mode:
-
In dev and test modes, it defaults to import.sql .
Simply add an import.sql file in the root of your resources directory
and it will be picked up without having to set this property.
Pass no-file to force Hibernate ORM to ignore the SQL import file.
-
In production mode, it defaults to no-file .
It means Hibernate ORM won’t try to execute any SQL import file by default.
Pass an explicit value to force Hibernate ORM to execute the SQL import file.
application.properties
%dev.quarkus.hibernate-orm.sql-load-script = import-dev.sql
%test.quarkus.hibernate-orm.sql-load-script = import-test.sql
%prod.quarkus.hibernate-orm.sql-load-script = no-file
|
Quarkus supports .sql file with SQL statements or comments spread over multiple lines.
Each SQL statement must be terminated by a semicolon.
|
Environment variable: QUARKUS_HIBERNATE_ORM_SQL_LOAD_SCRIPT
|
list of string |
import.sql in dev and test modes ; no-file otherwise
|
quarkus.hibernate-orm.physical-naming-strategy
quarkus.hibernate-orm."persistence-unit-name".physical-naming-strategy
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM_PHYSICAL_NAMING_STRATEGY
|
string |
|
quarkus.hibernate-orm.implicit-naming-strategy
quarkus.hibernate-orm."persistence-unit-name".implicit-naming-strategy
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation
Environment variable: QUARKUS_HIBERNATE_ORM_IMPLICIT_NAMING_STRATEGY
|
string |
|
quarkus.hibernate-orm.metadata-builder-contributor
quarkus.hibernate-orm."persistence-unit-name".metadata-builder-contributor
|
This setting is exposed mainly to allow registration of types, converters and SQL functions.
|
Environment variable: QUARKUS_HIBERNATE_ORM_METADATA_BUILDER_CONTRIBUTOR
|
string |
|
quarkus.hibernate-orm.mapping-files
quarkus.hibernate-orm."persistence-unit-name".mapping-files
XML files to configure the entity mapping, e.g. META-INF/my-orm.xml .
Defaults to META-INF/orm.xml if it exists. Pass no-file to force Hibernate ORM to ignore META-INF/orm.xml .
Environment variable: QUARKUS_HIBERNATE_ORM_MAPPING_FILES
|
list of string |
META-INF/orm.xml if it exists; no-file otherwise
|
quarkus.hibernate-orm.quote-identifiers.strategy
quarkus.hibernate-orm."persistence-unit-name".quote-identifiers.strategy
Identifiers can be quoted using one of the available strategies.
Set to none by default, meaning no identifiers will be quoted. If set to all , all identifiers and column definitions will be quoted. Additionally, setting it to all-except-column-definitions will skip the column definitions, which can usually be required when they exist, or else use the option only-keywords to quote only identifiers deemed SQL keywords by the Hibernate ORM dialect.
Environment variable: QUARKUS_HIBERNATE_ORM_QUOTE_IDENTIFIERS_STRATEGY
|
none , all , all-except-column-definitions , only-keywords
|
none
|
quarkus.hibernate-orm.second-level-caching-enabled
quarkus.hibernate-orm."persistence-unit-name".second-level-caching-enabled
The default in Quarkus is for 2nd level caching to be enabled, and a good implementation is already integrated for you.
Just cherry-pick which entities should be using the cache.
Set this to false to disable all 2nd level caches.
Environment variable: QUARKUS_HIBERNATE_ORM_SECOND_LEVEL_CACHING_ENABLED
|
boolean |
true
|
quarkus.hibernate-orm.validation.enabled
quarkus.hibernate-orm."persistence-unit-name".validation.enabled
Enables the Bean Validation integration.
Environment variable: QUARKUS_HIBERNATE_ORM_VALIDATION_ENABLED
|
boolean |
true
|
quarkus.hibernate-orm.multitenant
quarkus.hibernate-orm."persistence-unit-name".multitenant
Defines the method for multi-tenancy (DATABASE, NONE, SCHEMA). The complete list of allowed values is available in the
Hibernate ORM
JavaDoc.
The type DISCRIMINATOR is currently not supported. The default value is NONE (no multi-tenancy).
Environment variable: QUARKUS_HIBERNATE_ORM_MULTITENANT
|
string |
|
quarkus.hibernate-orm.validate-in-dev-mode
quarkus.hibernate-orm."persistence-unit-name".validate-in-dev-mode
If hibernate is not auto generating the schema, and Quarkus is running in development mode then Quarkus will attempt to validate the database after startup and print a log message if there are any problems.
Environment variable: QUARKUS_HIBERNATE_ORM_VALIDATE_IN_DEV_MODE
|
boolean |
true
|
quarkus.hibernate-orm.active
quarkus.hibernate-orm."persistence-unit-name".active
Whether this persistence unit should be active at runtime.
If the persistence unit is not active, it won’t start with the application,
and accessing the corresponding EntityManagerFactory/EntityManager or SessionFactory/Session
will not be possible.
Note that if Hibernate ORM is disabled (i.e. quarkus.hibernate-orm.enabled is set to false ),
all persistence units are deactivated, and setting this property to true will fail.
Environment variable: QUARKUS_HIBERNATE_ORM_ACTIVE
|
boolean |
'true' if Hibernate ORM is enabled; 'false' otherwise
|
quarkus.hibernate-orm.unsupported-properties."full-property-key"
quarkus.hibernate-orm."persistence-unit-name".unsupported-properties."full-property-key"
Properties that should be passed on directly to Hibernate ORM.
Use the full configuration property key here,
for instance quarkus.hibernate-orm.unsupported-properties."hibernate.order_inserts" = true .
|
Properties set here are completely unsupported:
as Quarkus doesn’t generally know about these properties and their purpose,
there is absolutely no guarantee that they will work correctly,
and even if they do, that may change when upgrading to a newer version of Quarkus
(even just a micro/patch version).
|
Consider using a supported configuration property before falling back to unsupported ones.
If none exists, make sure to file a feature request so that a supported configuration property can be added to Quarkus,
and more importantly so that the configuration property is tested regularly.
Environment variable: QUARKUS_HIBERNATE_ORM_UNSUPPORTED_PROPERTIES__FULL_PROPERTY_KEY_
|
Map<String,String> |
|
Database related configuration |
Type |
Default |
quarkus.hibernate-orm.database.orm-compatibility.version
When set, attempts to exchange data with the database
as the given version of Hibernate ORM would have,
on a best-effort basis.
-
schema validation may still fail in some cases:
this attempts to make Hibernate ORM 6+ behave correctly at runtime,
but it may still expect a different (but runtime-compatible) schema.
-
robust test suites are still useful and recommended:
you should still check that your application behaves as intended with your legacy schema.
-
this feature is inherently unstable:
some aspects of it may stop working in future versions of Quarkus,
and older versions will be dropped as Hibernate ORM changes pile up
and support for those older versions becomes too unreliable.
-
you should still plan a migration of your schema to a newer version of Hibernate ORM.
For help with migration, refer to
the Quarkus 3
migration guide from Hibernate ORM 5 to 6.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_ORM_COMPATIBILITY_VERSION
|
|
latest
|
quarkus.hibernate-orm.database.charset
quarkus.hibernate-orm."persistence-unit-name".database.charset
The charset of the database.
Used for DDL generation and also for the SQL import scripts.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_CHARSET
|
Charset |
UTF-8
|
quarkus.hibernate-orm.database.generation
quarkus.hibernate-orm."persistence-unit-name".database.generation
Select whether the database schema is generated or not. drop-and-create is awesome in development mode. This defaults to 'none', however if Dev Services is in use and no other extensions that manage the schema are present this will default to 'drop-and-create'. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION
|
string |
none
|
quarkus.hibernate-orm.database.generation.create-schemas
quarkus.hibernate-orm."persistence-unit-name".database.generation.create-schemas
If Hibernate ORM should create the schemas automatically (for databases supporting them).
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_CREATE_SCHEMAS
|
boolean |
false
|
quarkus.hibernate-orm.database.generation.halt-on-error
quarkus.hibernate-orm."persistence-unit-name".database.generation.halt-on-error
Whether we should stop on the first error when applying the schema.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_GENERATION_HALT_ON_ERROR
|
boolean |
false
|
quarkus.hibernate-orm.database.default-catalog
quarkus.hibernate-orm."persistence-unit-name".database.default-catalog
The default catalog to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_CATALOG
|
string |
|
quarkus.hibernate-orm.database.default-schema
quarkus.hibernate-orm."persistence-unit-name".database.default-schema
The default schema to use for the database objects.
Environment variable: QUARKUS_HIBERNATE_ORM_DATABASE_DEFAULT_SCHEMA
|
string |
|
Dialect related configuration |
Type |
Default |
quarkus.hibernate-orm.dialect
quarkus.hibernate-orm."persistence-unit-name".dialect
Name of the Hibernate ORM dialect.
If your database does not have a corresponding Quarkus extension,
you will need to set this property explicitly.
In that case, keep in mind that the JDBC driver and Hibernate ORM dialect
may not work properly in GraalVM native executables.
For built-in dialects, the expected value is one of the names
in the official list of dialects,
without the Dialect suffix,
for example Cockroach for CockroachDialect .
For third-party dialects, the expected value is the fully-qualified class name,
for example com.acme.hibernate.AcmeDbDialect .
Environment variable: QUARKUS_HIBERNATE_ORM_DIALECT
|
string |
selected automatically for most popular databases
|
quarkus.hibernate-orm.dialect.storage-engine
quarkus.hibernate-orm."persistence-unit-name".dialect.storage-engine
The storage engine to use when the dialect supports multiple storage engines.
E.g. MyISAM or InnoDB for MySQL.
Environment variable: QUARKUS_HIBERNATE_ORM_DIALECT_STORAGE_ENGINE
|
string |
|
Mapping configuration |
Type |
Default |
quarkus.hibernate-orm.mapping.timezone.default-storage
quarkus.hibernate-orm."persistence-unit-name".mapping.timezone.default-storage
How to store timezones in the database by default
for properties of type OffsetDateTime and ZonedDateTime .
This default may be overridden on a per-property basis using @TimeZoneStorage .
default
-
Equivalent to native if supported, normalize-utc otherwise.
auto
-
Equivalent to native if supported, column otherwise.
native
-
Stores the timestamp and timezone in a column of type timestamp with time zone .
Only available on some databases/dialects;
if not supported, an exception will be thrown during static initialization.
column
-
Stores the timezone in a separate column next to the timestamp column.
Use @TimeZoneColumn on the relevant entity property to customize the timezone column.
normalize-utc
-
Does not store the timezone, and loses timezone information upon persisting.
Instead, normalizes the value to a timestamp in the UTC timezone.
normalize
-
Does not store the timezone, and loses timezone information upon persisting.
Instead, normalizes the value:
* upon persisting to the database, to a timestamp in the JDBC timezone
set through quarkus.hibernate-orm.jdbc.timezone ,
or the JVM default timezone if not set.
* upon reading back from the database, to the JVM default timezone.
+
Use this to get the legacy behavior of Quarkus 2 / Hibernate ORM 5 or older.
Environment variable: QUARKUS_HIBERNATE_ORM_MAPPING_TIMEZONE_DEFAULT_STORAGE
|
native , normalize , normalize-utc , column , auto , default
|
default
|
quarkus.hibernate-orm.mapping.id.optimizer.default
quarkus.hibernate-orm."persistence-unit-name".mapping.id.optimizer.default
The optimizer to apply to identifier generators
whose optimizer is not configured explicitly.
Only relevant for table- and sequence-based identifier generators.
Other generators, such as UUID-based generators, will ignore this setting.
The optimizer is responsible for pooling new identifier values,
in order to reduce the frequency of database calls to retrieve those values
and thereby improve performance.
Environment variable: QUARKUS_HIBERNATE_ORM_MAPPING_ID_OPTIMIZER_DEFAULT
|
|
pooled-lo
|
Query related configuration |
Type |
Default |
quarkus.hibernate-orm.query.query-plan-cache-max-size
quarkus.hibernate-orm."persistence-unit-name".query.query-plan-cache-max-size
The maximum size of the query plan cache. see #org.hibernate.cfg.AvailableSettings#QUERY_PLAN_CACHE_MAX_SIZE
Environment variable: QUARKUS_HIBERNATE_ORM_QUERY_QUERY_PLAN_CACHE_MAX_SIZE
|
int |
2048
|
quarkus.hibernate-orm.query.default-null-ordering
quarkus.hibernate-orm."persistence-unit-name".query.default-null-ordering
Default precedence of null values in ORDER BY clauses.
Valid values are: none , first , last .
Environment variable: QUARKUS_HIBERNATE_ORM_QUERY_DEFAULT_NULL_ORDERING
|
|
none
|
quarkus.hibernate-orm.query.in-clause-parameter-padding
quarkus.hibernate-orm."persistence-unit-name".query.in-clause-parameter-padding
Enables IN clause parameter padding which improves statement caching.
Environment variable: QUARKUS_HIBERNATE_ORM_QUERY_IN_CLAUSE_PARAMETER_PADDING
|
boolean |
true
|
JDBC related configuration |
Type |
Default |
quarkus.hibernate-orm.jdbc.timezone
quarkus.hibernate-orm."persistence-unit-name".jdbc.timezone
The time zone pushed to the JDBC driver. See quarkus.hibernate-orm.mapping.timezone.default-storage .
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_TIMEZONE
|
string |
|
quarkus.hibernate-orm.jdbc.statement-fetch-size
quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-fetch-size
How many rows are fetched at a time by the JDBC driver.
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_FETCH_SIZE
|
int |
|
quarkus.hibernate-orm.jdbc.statement-batch-size
quarkus.hibernate-orm."persistence-unit-name".jdbc.statement-batch-size
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.
Environment variable: QUARKUS_HIBERNATE_ORM_JDBC_STATEMENT_BATCH_SIZE
|
int |
|
Fetching logic configuration |
Type |
Default |
quarkus.hibernate-orm.fetch.batch-size
quarkus.hibernate-orm."persistence-unit-name".fetch.batch-size
The size of the batches used when loading entities and collections.
-1 means batch loading is disabled.
Environment variable: QUARKUS_HIBERNATE_ORM_FETCH_BATCH_SIZE
|
int |
16
|
quarkus.hibernate-orm.fetch.max-depth
quarkus.hibernate-orm."persistence-unit-name".fetch.max-depth
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one).
A 0 disables default outer join fetching.
Environment variable: QUARKUS_HIBERNATE_ORM_FETCH_MAX_DEPTH
|
int |
|
Caching configuration |
Type |
Default |
quarkus.hibernate-orm.cache."cache".expiration.max-idle
quarkus.hibernate-orm."persistence-unit-name".cache."cache".expiration.max-idle
The maximum time before an object of the cache is considered expired.
Environment variable: QUARKUS_HIBERNATE_ORM_CACHE__CACHE__EXPIRATION_MAX_IDLE
|
Duration |
|
quarkus.hibernate-orm.cache."cache".memory.object-count
quarkus.hibernate-orm."persistence-unit-name".cache."cache".memory.object-count
The maximum number of objects kept in memory in the cache.
Environment variable: QUARKUS_HIBERNATE_ORM_CACHE__CACHE__MEMORY_OBJECT_COUNT
|
long |
|
Discriminator related configuration |
Type |
Default |
quarkus.hibernate-orm.discriminator.ignore-explicit-for-joined
quarkus.hibernate-orm."persistence-unit-name".discriminator.ignore-explicit-for-joined
Existing applications rely (implicitly or explicitly) on Hibernate ignoring any DiscriminatorColumn declarations on joined inheritance hierarchies. This setting allows these applications to maintain the legacy behavior of DiscriminatorColumn annotations being ignored when paired with joined inheritance.
Environment variable: QUARKUS_HIBERNATE_ORM_DISCRIMINATOR_IGNORE_EXPLICIT_FOR_JOINED
|
boolean |
false
|
Logging configuration |
Type |
Default |
quarkus.hibernate-orm.log.bind-parameters
Logs SQL bind parameters.
Setting it to true is obviously not recommended in production.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_BIND_PARAMETERS
|
boolean |
false
|
quarkus.hibernate-orm.log.sql
quarkus.hibernate-orm."persistence-unit-name".log.sql
Show SQL logs and format them nicely.
Setting it to true is obviously not recommended in production.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_SQL
|
boolean |
false
|
quarkus.hibernate-orm.log.format-sql
quarkus.hibernate-orm."persistence-unit-name".log.format-sql
Format the SQL logs if SQL log is enabled
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_FORMAT_SQL
|
boolean |
true
|
quarkus.hibernate-orm.log.highlight-sql
quarkus.hibernate-orm."persistence-unit-name".log.highlight-sql
Highlight the SQL logs if SQL log is enabled
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_HIGHLIGHT_SQL
|
boolean |
true
|
quarkus.hibernate-orm.log.jdbc-warnings
quarkus.hibernate-orm."persistence-unit-name".log.jdbc-warnings
Whether JDBC warnings should be collected and logged.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_JDBC_WARNINGS
|
boolean |
depends on dialect
|
quarkus.hibernate-orm.log.queries-slower-than-ms
quarkus.hibernate-orm."persistence-unit-name".log.queries-slower-than-ms
If set, Hibernate will log queries that took more than specified number of milliseconds to execute.
Environment variable: QUARKUS_HIBERNATE_ORM_LOG_QUERIES_SLOWER_THAN_MS
|
long |
|
Database scripts related configuration |
Type |
Default |
quarkus.hibernate-orm.scripts.generation
quarkus.hibernate-orm."persistence-unit-name".scripts.generation
Select whether the database schema DDL files are generated or not. Accepted values: none , create , drop-and-create , drop , update , validate .
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION
|
string |
none
|
quarkus.hibernate-orm.scripts.generation.create-target
quarkus.hibernate-orm."persistence-unit-name".scripts.generation.create-target
Filename or URL where the database create DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_CREATE_TARGET
|
string |
|
quarkus.hibernate-orm.scripts.generation.drop-target
quarkus.hibernate-orm."persistence-unit-name".scripts.generation.drop-target
Filename or URL where the database drop DDL file should be generated.
Environment variable: QUARKUS_HIBERNATE_ORM_SCRIPTS_GENERATION_DROP_TARGET
|
string |
|
Hibernate Search + Elasticsearch |
Type |
Default |
quarkus.hibernate-search-orm.enabled
Whether Hibernate Search is enabled during the build.
If Hibernate Search is disabled during the build, all processing related to Hibernate Search will be skipped,
but it will not be possible to activate Hibernate Search at runtime:
quarkus.hibernate-search-orm.active will default to false and setting it to true will lead to an error.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-orm.background-failure-handler
quarkus.hibernate-search-orm."persistence-unit-name".background-failure-handler
A bean reference to a component
that should be notified of any failure occurring in a background process
(mainly index operations).
The referenced bean must implement FailureHandler .
|
Instead of setting this configuration property,
you can simply annotate your custom FailureHandler implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_BACKGROUND_FAILURE_HANDLER
|
string |
|
quarkus.hibernate-search-orm.coordination.strategy
quarkus.hibernate-search-orm."persistence-unit-name".coordination.strategy
The strategy to use for coordinating between threads or even separate instances of the application,
in particular in automatic indexing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_STRATEGY
|
string |
none
|
quarkus.hibernate-search-orm.mapping.configurer
quarkus.hibernate-search-orm."persistence-unit-name".mapping.configurer
One or more bean references
to the component(s) used to configure the Hibernate Search mapping,
in particular programmatically.
The referenced beans must implement HibernateOrmSearchMappingConfigurer .
See Programmatic mapping for an example
on how mapping configurers can be used to apply programmatic mappings.
|
Instead of setting this configuration property,
you can simply annotate your custom HibernateOrmSearchMappingConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_MAPPING_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-orm.active
quarkus.hibernate-search-orm."persistence-unit-name".active
Whether Hibernate Search should be active for this persistence unit at runtime.
If Hibernate Search is not active, it won’t index Hibernate ORM entities,
and accessing the SearchMapping/SearchSession of the relevant persistence unit
for search or other operation will not be possible.
Note that if Hibernate Search is disabled (i.e. quarkus.hibernate-search-orm.enabled is set to false ),
it won’t be active for any persistence unit, and setting this property to true will fail.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ACTIVE
|
boolean |
'true' if Hibernate Search is enabled; 'false' otherwise
|
quarkus.hibernate-search-orm.schema-management.strategy
quarkus.hibernate-search-orm."persistence-unit-name".schema-management.strategy
The schema management strategy, controlling how indexes and their schema
are created, updated, validated or dropped on startup and shutdown.
Strategy |
Definition |
none |
Do nothing: assume that indexes already exist and that their schema matches Hibernate Search’s expectations. |
validate |
Validate that indexes exist and that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, do nothing: assume that their schema matches Hibernate Search’s expectations. |
create-or-validate (default unless using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create-or-update |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations;
if it does not match expectations, try to update it.
This strategy is unfit for production environments,
due to several important limitations,
but can be useful when developing. |
drop-and-create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema. |
drop-and-create-and-drop (default when using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema.
Also, drop indexes and their schema on shutdown. |
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_SCHEMA_MANAGEMENT_STRATEGY
|
none , validate , create , create-or-validate , create-or-update , drop-and-create , drop-and-create-and-drop
|
drop-and-create-and-drop when using Dev Services; create-or-validate otherwise
|
quarkus.hibernate-search-orm.query.loading.cache-lookup.strategy
quarkus.hibernate-search-orm."persistence-unit-name".query.loading.cache-lookup.strategy
The strategy to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_QUERY_LOADING_CACHE_LOOKUP_STRATEGY
|
skip , persistence-context , persistence-context-then-second-level-cache
|
skip
|
quarkus.hibernate-search-orm.query.loading.fetch-size
quarkus.hibernate-search-orm."persistence-unit-name".query.loading.fetch-size
The fetch size to use when loading entities during the execution of a search query.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_QUERY_LOADING_FETCH_SIZE
|
int |
100
|
quarkus.hibernate-search-orm.indexing.plan.synchronization.strategy
quarkus.hibernate-search-orm."persistence-unit-name".indexing.plan.synchronization.strategy
How to synchronize between application threads and indexing,
in particular when relying on (implicit) listener-triggered indexing on entity change,
but also when using a SearchIndexingPlan explicitly.
Defines how complete indexing should be before resuming the application thread
after a database transaction is committed.
|
Indexing synchronization is only relevant when coordination is disabled (which is the default).
With the outbox-polling coordination strategy,
indexing happens in background threads and is always asynchronous;
the behavior is equivalent to the write-sync synchronization strategy.
|
Strategy |
Throughput |
Guarantees when the application thread resumes |
Changes applied |
Changes safe from crash/power loss |
Changes visible on search |
async |
Best |
|
|
|
write-sync (default) |
Medium |
|
|
|
read-sync |
Medium to worst |
|
|
|
sync |
Worst |
|
|
|
This property also accepts a bean reference
to a custom implementations of IndexingPlanSynchronizationStrategy .
|
Instead of setting this configuration property,
you can simply annotate your custom IndexingPlanSynchronizationStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_INDEXING_PLAN_SYNCHRONIZATION_STRATEGY
|
string |
write-sync
|
quarkus.hibernate-search-orm.multi-tenancy.tenant-ids
quarkus.hibernate-search-orm."persistence-unit-name".multi-tenancy.tenant-ids
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.
Mainly useful when using the {@code outbox-polling} coordination strategy,
since it involves setting up one background processor per tenant.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_MULTI_TENANCY_TENANT_IDS
|
list of string |
|
Configuration for backends |
Type |
Default |
quarkus.hibernate-search-orm.elasticsearch.version
quarkus.hibernate-search-orm.elasticsearch."backend-name".version
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version
The version of Elasticsearch used in the cluster.
As the schema is generated without a connection to the server, this item is mandatory.
It doesn’t have to be the exact version (it can be 7 or 7.1 for instance) but it has to be sufficiently precise
to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used
to communicate with Elasticsearch).
There’s no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In
any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION
|
ElasticsearchVersion |
|
quarkus.hibernate-search-orm.elasticsearch.layout.strategy
quarkus.hibernate-search-orm.elasticsearch."backend-name".layout.strategy
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.layout.strategy
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".layout.strategy
A bean reference to the component
used to configure the Elasticsearch layout: index names, index aliases, …
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_LAYOUT_STRATEGY
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.schema-management.settings-file
quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.settings-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.settings-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.settings-file
Path to a file in the classpath holding custom index settings to be included in the index definition
when creating an Elasticsearch index.
The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions.
When analysis is configured both through an analysis configurer and these custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.schema-management.mapping-file
quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.mapping-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.mapping-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.mapping-file
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.analysis.configurer
quarkus.hibernate-search-orm.elasticsearch."backend-name".analysis.configurer
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.analysis.configurer
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".analysis.configurer
One or more bean references
to the component(s) used to configure full text analysis (e.g. analyzers, normalizers).
The referenced beans must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_ANALYSIS_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-orm.elasticsearch.hosts
quarkus.hibernate-search-orm.elasticsearch."backend-name".hosts
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.hosts
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".hosts
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_HOSTS
|
list of string |
localhost:9200
|
quarkus.hibernate-search-orm.elasticsearch.protocol
quarkus.hibernate-search-orm.elasticsearch."backend-name".protocol
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.protocol
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".protocol
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PROTOCOL
|
|
http
|
quarkus.hibernate-search-orm.elasticsearch.username
quarkus.hibernate-search-orm.elasticsearch."backend-name".username
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.username
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".username
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_USERNAME
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.password
quarkus.hibernate-search-orm.elasticsearch."backend-name".password
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.password
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".password
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_PASSWORD
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.connection-timeout
quarkus.hibernate-search-orm.elasticsearch."backend-name".connection-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.connection-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".connection-timeout
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration |
1S
|
quarkus.hibernate-search-orm.elasticsearch.read-timeout
quarkus.hibernate-search-orm.elasticsearch."backend-name".read-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.read-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".read-timeout
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_READ_TIMEOUT
|
Duration |
30S
|
quarkus.hibernate-search-orm.elasticsearch.request-timeout
quarkus.hibernate-search-orm.elasticsearch."backend-name".request-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.request-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".request-timeout
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available,
send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_REQUEST_TIMEOUT
|
Duration |
|
quarkus.hibernate-search-orm.elasticsearch.max-connections
quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
quarkus.hibernate-search-orm.elasticsearch.max-connections-per-route
quarkus.hibernate-search-orm.elasticsearch."backend-name".max-connections-per-route
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.max-connections-per-route
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".max-connections-per-route
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
quarkus.hibernate-search-orm.elasticsearch.discovery.enabled
quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.enabled
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.enabled
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.enabled
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
quarkus.hibernate-search-orm.elasticsearch.discovery.refresh-interval
quarkus.hibernate-search-orm.elasticsearch."backend-name".discovery.refresh-interval
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.discovery.refresh-interval
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".discovery.refresh-interval
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration |
10S
|
quarkus.hibernate-search-orm.elasticsearch.thread-pool.size
quarkus.hibernate-search-orm.elasticsearch."backend-name".thread-pool.size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.thread-pool.size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".thread-pool.size
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index.
Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking,
raising its size above the number of processor cores available to the JVM will not bring noticeable performance
benefit.
The only reason to alter this setting would be to reduce the number of threads;
for example, in an application with a single index with a single indexing queue,
running on a machine with 64 processor cores,
you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_THREAD_POOL_SIZE
|
int |
|
quarkus.hibernate-search-orm.elasticsearch.query.shard-failure.ignore
quarkus.hibernate-search-orm.elasticsearch."backend-name".query.shard-failure.ignore
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.query.shard-failure.ignore
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".query.shard-failure.ignore
Whether partial shard failures are ignored (true ) or lead to Hibernate Search throwing an exception (false ).
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE
|
boolean |
false
|
quarkus.hibernate-search-orm.elasticsearch.version-check.enabled
quarkus.hibernate-search-orm.elasticsearch."backend-name".version-check.enabled
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.version-check.enabled
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".version-check.enabled
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_VERSION_CHECK_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status
quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
quarkus.hibernate-search-orm.elasticsearch.schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm.elasticsearch."backend-name".schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".schema-management.required-status-wait-timeout
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration |
10S
|
quarkus.hibernate-search-orm.elasticsearch.indexing.queue-count
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-count
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-count
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-count
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_COUNT
|
int |
10
|
quarkus.hibernate-search-orm.elasticsearch.indexing.queue-size
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.queue-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.queue-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.queue-size
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues,
but values that are too low will reduce the likeliness of reaching the max bulk size
and increase the likeliness of application threads blocking because the queue is full,
which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_QUEUE_SIZE
|
int |
1000
|
quarkus.hibernate-search-orm.elasticsearch.indexing.max-bulk-size
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexing.max-bulk-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexing.max-bulk-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexing.max-bulk-size
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect,
as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE
|
int |
100
|
Per-index configuration overrides |
Type |
Default |
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.settings-file
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.settings-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.settings-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.settings-file
Path to a file in the classpath holding custom index settings to be included in the index definition
when creating an Elasticsearch index.
The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions.
When analysis is configured both through an analysis configurer and these custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.mapping-file
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.mapping-file
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".analysis.configurer
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".analysis.configurer
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".analysis.configurer
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".analysis.configurer
One or more bean references
to the component(s) used to configure full text analysis (e.g. analyzers, normalizers).
The referenced beans must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration |
10S
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-count
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-count
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-count
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-count
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.queue-size
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.queue-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.queue-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.queue-size
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues,
but values that are too low will reduce the likeliness of reaching the max bulk size
and increase the likeliness of application threads blocking because the queue is full,
which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
quarkus.hibernate-search-orm.elasticsearch.indexes."index-name".indexing.max-bulk-size
quarkus.hibernate-search-orm.elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch.indexes."index-name".indexing.max-bulk-size
quarkus.hibernate-search-orm."persistence-unit-name".elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect,
as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Management interface |
Type |
Default |
quarkus.hibernate-search-orm.management.root-path
Root path for reindexing endpoints.
This value will be resolved as a path relative to ${quarkus.management.root-path} .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_MANAGEMENT_ROOT_PATH
|
string |
hibernate-search/
|
quarkus.hibernate-search-orm.management.enabled
If management interface is turned on the reindexing endpoints will be published under the management interface.
This property allows to enable this functionality by setting it to `true .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_MANAGEMENT_ENABLED
|
boolean |
false
|
Hibernate Search Coordination with Outbox Polling |
Type |
Default |
quarkus.hibernate-search-orm.coordination.event-processor.enabled
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.enabled
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-orm.coordination.event-processor.shards.total-count
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.shards.total-count
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
quarkus.hibernate-search-orm.coordination.event-processor.shards.assigned
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.shards.assigned
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
quarkus.hibernate-search-orm.coordination.event-processor.polling-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.polling-interval
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration |
0.100S
|
quarkus.hibernate-search-orm.coordination.event-processor.pulse-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.pulse-interval
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration |
2S
|
quarkus.hibernate-search-orm.coordination.event-processor.pulse-expiration
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.pulse-expiration
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration |
30S
|
quarkus.hibernate-search-orm.coordination.event-processor.batch-size
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.batch-size
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryError s.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
quarkus.hibernate-search-orm.coordination.event-processor.transaction-timeout
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.transaction-timeout
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration |
|
quarkus.hibernate-search-orm.coordination.event-processor.retry-delay
quarkus.hibernate-search-orm."persistence-unit-name".coordination.event-processor.retry-delay
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_EVENT_PROCESSOR_RETRY_DELAY
|
Duration |
30S
|
quarkus.hibernate-search-orm.coordination.mass-indexer.polling-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.mass-indexer.polling-interval
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_POLLING_INTERVAL
|
Duration |
0.100S
|
quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.mass-indexer.pulse-interval
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_INTERVAL
|
Duration |
2S
|
quarkus.hibernate-search-orm.coordination.mass-indexer.pulse-expiration
quarkus.hibernate-search-orm."persistence-unit-name".coordination.mass-indexer.pulse-expiration
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_MASS_INDEXER_PULSE_EXPIRATION
|
Duration |
30S
|
Configuration for persistence units |
Type |
Default |
Configuration for the mapping of entities used for outbox-polling coordination |
Type |
Default |
quarkus.hibernate-search-orm.coordination.entity-mapping.agent.catalog
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.agent.catalog
The database catalog to use for the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_AGENT_CATALOG
|
string |
Default catalog configured in Hibernate ORM
|
quarkus.hibernate-search-orm.coordination.entity-mapping.agent.schema
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.agent.schema
The schema catalog to use for the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_AGENT_SCHEMA
|
string |
Default catalog configured in Hibernate ORM
|
quarkus.hibernate-search-orm.coordination.entity-mapping.agent.table
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.agent.table
The name of the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_AGENT_TABLE
|
string |
HSEARCH_AGENT
|
quarkus.hibernate-search-orm.coordination.entity-mapping.agent.uuid-gen-strategy
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.agent.uuid-gen-strategy
The UUID generator strategy used for the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_AGENT_UUID_GEN_STRATEGY
|
|
auto
|
quarkus.hibernate-search-orm.coordination.entity-mapping.agent.uuid-type
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.agent.uuid-type
The name of the Hibernate ORM basic type used for representing an UUID in the outbox event table.
Defaults to the special value default , which will result into one of char /binary
depending on the database kind.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_AGENT_UUID_TYPE
|
string |
char/binary depending on the database kind
|
quarkus.hibernate-search-orm.coordination.entity-mapping.outbox-event.catalog
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.outbox-event.catalog
The database catalog to use for the outbox event table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_OUTBOX_EVENT_CATALOG
|
string |
Default catalog configured in Hibernate ORM
|
quarkus.hibernate-search-orm.coordination.entity-mapping.outbox-event.schema
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.outbox-event.schema
The schema catalog to use for the outbox event table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_OUTBOX_EVENT_SCHEMA
|
string |
Default schema configured in Hibernate ORM
|
quarkus.hibernate-search-orm.coordination.entity-mapping.outbox-event.table
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.outbox-event.table
The name of the outbox event table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_OUTBOX_EVENT_TABLE
|
string |
HSEARCH_OUTBOX_EVENT
|
quarkus.hibernate-search-orm.coordination.entity-mapping.outbox-event.uuid-gen-strategy
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.outbox-event.uuid-gen-strategy
The UUID generator strategy used for the outbox event table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_OUTBOX_EVENT_UUID_GEN_STRATEGY
|
|
auto
|
quarkus.hibernate-search-orm.coordination.entity-mapping.outbox-event.uuid-type
quarkus.hibernate-search-orm."persistence-unit-name".coordination.entity-mapping.outbox-event.uuid-type
The name of the Hibernate ORM basic type used for representing an UUID in the outbox event table.
Defaults to the special value default , which will result into one of char /binary
depending on the database kind.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_ENTITY_MAPPING_OUTBOX_EVENT_UUID_TYPE
|
string |
char/binary depending on the database kind
|
Per-tenant configuration overrides |
Type |
Default |
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.enabled
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.enabled
Whether the event processor is enabled,
i.e. whether events will be processed to perform automatic reindexing on this instance of the application.
This can be set to false to disable event processing on some application nodes,
for example to dedicate some nodes to HTTP request processing and other nodes to event processing.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.shards.total-count
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.shards.total-count
The total number of shards that will form a partition of the entity change events to process.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the assigned shards (see shards.assigned )
is necessary.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_TOTAL_COUNT
|
int |
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.shards.assigned
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.shards.assigned
Among shards that will form a partition of the entity change events,
the shards that will be processed by this application instance.
By default, sharding is dynamic and setting this property is not necessary.
If you want to control explicitly the number and assignment of shards,
you must configure static sharding and then setting this property as well as the total shard count
is necessary.
Shards are referred to by an index in the range [0, total_count - 1] (see shards.total-count ).
A given application node must be assigned at least one shard but may be assigned multiple shards
by setting shards.assigned to a comma-separated list, e.g. 0,3 .
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_SHARDS_ASSIGNED
|
list of int |
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.polling-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.polling-interval
How long to wait for another query to the outbox events table after a query didn’t return any event.
Lower values will reduce the time it takes for a change to be reflected in the index,
but will increase the stress on the database when there are no new events.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_POLLING_INTERVAL
|
Duration |
0.100S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.pulse-interval
How long the event processor can poll for events before it must perform a "pulse",
updating and checking registrations in the agents table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean less time wasted not processing events
when a node joins or leaves the cluster,
and reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but more stress on the database because of more frequent checks of the list of agents.
High values (closer to the expiration interval) mean more time wasted not processing events
when a node joins or leaves the cluster,
and increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected,
but less stress on the database because of less frequent checks of the list of agents.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_INTERVAL
|
Duration |
2S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.pulse-expiration
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.pulse-expiration
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but increased risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted not processing events
when a node abruptly leaves the cluster due to a crash or network failure,
but reduced risk of wasting time not processing events
because an event processor is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_PULSE_EXPIRATION
|
Duration |
30S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.batch-size
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.batch-size
How many outbox events, at most, are processed in a single transaction.
Higher values will reduce the number of transactions opened by the background process
and may increase performance thanks to the first-level cache (persistence context),
but will increase memory usage and in extreme cases may lead to OutOfMemoryError s.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_BATCH_SIZE
|
int |
50
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.transaction-timeout
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.transaction-timeout
The timeout for transactions processing outbox events.
When this property is not set,
Hibernate Search will use whatever default transaction timeout is configured in the JTA transaction manager,
which may be too low for batch processing and lead to transaction timeouts when processing batches of events.
If this happens, set a higher transaction timeout for event processing using this property.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_TRANSACTION_TIMEOUT
|
Duration |
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".event-processor.retry-delay
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".event-processor.retry-delay
How long the event processor must wait before re-processing an event after its previous processing failed.
Use the value 0S to reprocess failed events as soon as possible, with no delay.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__EVENT_PROCESSOR_RETRY_DELAY
|
Duration |
30S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.polling-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".mass-indexer.polling-interval
How long to wait for another query to the agent table
when actively waiting for event processors to suspend themselves.
Low values will reduce the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will increase the stress on the database while the mass indexer agent is actively waiting.
High values will increase the time it takes for the mass indexer agent to detect
that event processors finally suspended themselves,
but will reduce the stress on the database while the mass indexer agent is actively waiting.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_POLLING_INTERVAL
|
Duration |
0.100S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-interval
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".mass-indexer.pulse-interval
How long the mass indexer can wait before it must perform a "pulse",
updating and checking registrations in the agent table.
The pulse interval must be set to a value between the polling interval
and one third (1/3) of the expiration interval.
Low values (closer to the polling interval) mean reduced risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but more stress on the database because of more frequent updates of the mass indexer agent’s entry in the agent table.
High values (closer to the expiration interval) mean increased risk of
event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected,
but less stress on the database because of less frequent updates of the mass indexer agent’s entry in the agent table.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_INTERVAL
|
Duration |
2S
|
quarkus.hibernate-search-orm.coordination.tenants."tenant-id".mass-indexer.pulse-expiration
quarkus.hibernate-search-orm."persistence-unit-name".coordination.tenants."tenant-id".mass-indexer.pulse-expiration
How long an event processor "pulse" remains valid before considering the processor disconnected
and forcibly removing it from the cluster.
The expiration interval must be set to a value at least 3 times larger than the pulse interval.
Low values (closer to the pulse interval) mean less time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but increased risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
High values (much larger than the pulse interval) mean more time wasted with event processors not processing events
when a mass indexer agent terminates due to a crash,
but reduced risk of event processors starting to process events again during mass indexing
because a mass indexer agent is incorrectly considered disconnected.
Environment variable: QUARKUS_HIBERNATE_SEARCH_ORM_COORDINATION_TENANTS__TENANT_ID__MASS_INDEXER_PULSE_EXPIRATION
|
Duration |
30S
|
Hibernate Search Standalone + Elasticsearch |
Type |
Default |
quarkus.hibernate-search-standalone.enabled
Whether Hibernate Search Standalone is enabled during the build.
If Hibernate Search is disabled during the build, all processing related to Hibernate Search will be skipped,
but it will not be possible to activate Hibernate Search at runtime:
quarkus.hibernate-search-standalone.active will default to false and setting it to true will lead to an error.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-standalone.background-failure-handler
A bean reference to a component
that should be notified of any failure occurring in a background process
(mainly index operations).
The referenced bean must implement FailureHandler .
|
Instead of setting this configuration property,
you can simply annotate your custom FailureHandler implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_BACKGROUND_FAILURE_HANDLER
|
string |
|
quarkus.hibernate-search-standalone.mapping.configurer
One or more bean references
to the component(s) used to configure the Hibernate Search mapping,
in particular programmatically.
The referenced beans must implement StandalonePojoMappingConfigurer .
See Programmatic mapping for an example
on how mapping configurers can be used to apply programmatic mappings.
|
Instead of setting this configuration property,
you can simply annotate your custom StandalonePojoMappingConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_MAPPING_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-standalone.mapping.structure
The structure of the Hibernate Search entity mapping.
This must match the structure of the application model being indexed with Hibernate Search:
graph (default)
-
Entities indexed through Hibernate Search are nodes in an entity graph,
i.e. an indexed entity is independent of other entities it references through associations,
which can be updated independently of the indexed entity.
Associations between entities must be bi-directional:
specifying the inverse side of associations through @AssociationInverseSide is required,
unless reindexing is disabled for that association through @IndexingDependency(reindexOnUpdate = …) .
document
-
Entities indexed through Hibernate Search are the root of a document,
i.e. an indexed entity "owns" other entities it references through associations,
which cannot be updated independently of the indexed entity.
Associations between entities can be uni-directional:
specifying the inverse side of associations through @AssociationInverseSide is not required.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_MAPPING_STRUCTURE
|
|
graph
|
quarkus.hibernate-search-standalone.active
Whether Hibernate Search Standalone should be active at runtime.
If Hibernate Search Standalone is not active, it won’t start with the application,
and accessing the SearchMapping for search or other operations will not be possible.
Note that if Hibernate Search Standalone is disabled
(i.e. quarkus.hibernate-search-standalone.enabled is set to false ),
it won’t be active, and setting this property to true will fail.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ACTIVE
|
boolean |
'true' if Hibernate Search Standalone is enabled; 'false' otherwise
|
quarkus.hibernate-search-standalone.schema-management.strategy
The schema management strategy, controlling how indexes and their schema
are created, updated, validated or dropped on startup and shutdown.
Strategy |
Definition |
none |
Do nothing: assume that indexes already exist and that their schema matches Hibernate Search’s expectations. |
validate |
Validate that indexes exist and that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, do nothing: assume that their schema matches Hibernate Search’s expectations. |
create-or-validate (default unless using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations.
If it does not, throw an exception, but make no attempt to fix the problem. |
create-or-update |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, validate that their schema matches Hibernate Search’s expectations;
if it does not match expectations, try to update it.
This strategy is unfit for production environments,
due to several important limitations,
but can be useful when developing. |
drop-and-create |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema. |
drop-and-create-and-drop (default when using Dev Services) |
For indexes that do not exist, create them along with their schema.
For indexes that already exist, drop them, then create them along with their schema.
Also, drop indexes and their schema on shutdown. |
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_SCHEMA_MANAGEMENT_STRATEGY
|
none , validate , create , create-or-validate , create-or-update , drop-and-create , drop-and-create-and-drop
|
drop-and-create-and-drop when using Dev Services; create-or-validate otherwise
|
quarkus.hibernate-search-standalone.indexing.plan.synchronization.strategy
How to synchronize between application threads and indexing,
in particular when relying on (implicit) listener-triggered indexing on entity change,
but also when using a SearchIndexingPlan explicitly.
Defines how complete indexing should be before resuming the application thread
after a SearchSession is closed.
Strategy |
Throughput |
Guarantees when the application thread resumes |
Changes applied |
Changes safe from crash/power loss |
Changes visible on search |
async |
Best |
|
|
|
write-sync (default) |
Medium |
|
|
|
read-sync |
Medium to worst |
|
|
|
sync |
Worst |
|
|
|
This property also accepts a bean reference
to a custom implementations of IndexingPlanSynchronizationStrategy .
|
Instead of setting this configuration property,
you can simply annotate your custom IndexingPlanSynchronizationStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_INDEXING_PLAN_SYNCHRONIZATION_STRATEGY
|
string |
write-sync
|
Configuration for backends |
Type |
Default |
quarkus.hibernate-search-standalone.elasticsearch.version
quarkus.hibernate-search-standalone.elasticsearch."backend-name".version
The version of Elasticsearch used in the cluster.
As the schema is generated without a connection to the server, this item is mandatory.
It doesn’t have to be the exact version (it can be 7 or 7.1 for instance) but it has to be sufficiently precise
to choose a model dialect (the one used to generate the schema) compatible with the protocol dialect (the one used
to communicate with Elasticsearch).
There’s no rule of thumb here as it depends on the schema incompatibilities introduced by Elasticsearch versions. In
any case, if there is a problem, you will have an error when Hibernate Search tries to connect to the cluster.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_VERSION
|
ElasticsearchVersion |
|
quarkus.hibernate-search-standalone.elasticsearch.layout.strategy
quarkus.hibernate-search-standalone.elasticsearch."backend-name".layout.strategy
A bean reference to the component
used to configure the Elasticsearch layout: index names, index aliases, …
The referenced bean must implement IndexLayoutStrategy .
Available built-in implementations:
simple
-
The default, future-proof strategy: if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex-000001 , an alias for write operations named myindex-write ,
and an alias for read operations named myindex-read .
no-alias
-
A strategy without index aliases, mostly useful on legacy clusters:
if the index name in Hibernate Search is myIndex ,
this strategy will create an index named myindex , and will not use any alias.
|
Instead of setting this configuration property,
you can simply annotate your custom IndexLayoutStrategy implementation with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_LAYOUT_STRATEGY
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.schema-management.settings-file
quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.settings-file
Path to a file in the classpath holding custom index settings to be included in the index definition
when creating an Elasticsearch index.
The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions.
When analysis is configured both through an analysis configurer and these custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.schema-management.mapping-file
quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.mapping-file
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.analysis.configurer
quarkus.hibernate-search-standalone.elasticsearch."backend-name".analysis.configurer
One or more bean references
to the component(s) used to configure full text analysis (e.g. analyzers, normalizers).
The referenced beans must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_ANALYSIS_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-standalone.elasticsearch.hosts
quarkus.hibernate-search-standalone.elasticsearch."backend-name".hosts
The list of hosts of the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_HOSTS
|
list of string |
localhost:9200
|
quarkus.hibernate-search-standalone.elasticsearch.protocol
quarkus.hibernate-search-standalone.elasticsearch."backend-name".protocol
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_PROTOCOL
|
|
http
|
quarkus.hibernate-search-standalone.elasticsearch.username
quarkus.hibernate-search-standalone.elasticsearch."backend-name".username
The username used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_USERNAME
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.password
quarkus.hibernate-search-standalone.elasticsearch."backend-name".password
The password used for authentication.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_PASSWORD
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.connection-timeout
quarkus.hibernate-search-standalone.elasticsearch."backend-name".connection-timeout
The timeout when establishing a connection to an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_CONNECTION_TIMEOUT
|
Duration |
1S
|
quarkus.hibernate-search-standalone.elasticsearch.read-timeout
quarkus.hibernate-search-standalone.elasticsearch."backend-name".read-timeout
The timeout when reading responses from an Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_READ_TIMEOUT
|
Duration |
30S
|
quarkus.hibernate-search-standalone.elasticsearch.request-timeout
quarkus.hibernate-search-standalone.elasticsearch."backend-name".request-timeout
The timeout when executing a request to an Elasticsearch server.
This includes the time needed to wait for a connection to be available,
send the request and read the response.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_REQUEST_TIMEOUT
|
Duration |
|
quarkus.hibernate-search-standalone.elasticsearch.max-connections
quarkus.hibernate-search-standalone.elasticsearch."backend-name".max-connections
The maximum number of connections to all the Elasticsearch servers.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_MAX_CONNECTIONS
|
int |
20
|
quarkus.hibernate-search-standalone.elasticsearch.max-connections-per-route
quarkus.hibernate-search-standalone.elasticsearch."backend-name".max-connections-per-route
The maximum number of connections per Elasticsearch server.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_MAX_CONNECTIONS_PER_ROUTE
|
int |
10
|
quarkus.hibernate-search-standalone.elasticsearch.discovery.enabled
quarkus.hibernate-search-standalone.elasticsearch."backend-name".discovery.enabled
Defines if automatic discovery is enabled.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_DISCOVERY_ENABLED
|
boolean |
false
|
quarkus.hibernate-search-standalone.elasticsearch.discovery.refresh-interval
quarkus.hibernate-search-standalone.elasticsearch."backend-name".discovery.refresh-interval
Refresh interval of the node list.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_DISCOVERY_REFRESH_INTERVAL
|
Duration |
10S
|
quarkus.hibernate-search-standalone.elasticsearch.thread-pool.size
quarkus.hibernate-search-standalone.elasticsearch."backend-name".thread-pool.size
The size of the thread pool assigned to the backend.
Note that number is per backend, not per index.
Adding more indexes will not add more threads.
As all operations happening in this thread-pool are non-blocking,
raising its size above the number of processor cores available to the JVM will not bring noticeable performance
benefit.
The only reason to alter this setting would be to reduce the number of threads;
for example, in an application with a single index with a single indexing queue,
running on a machine with 64 processor cores,
you might want to bring down the number of threads.
Defaults to the number of processor cores available to the JVM on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_THREAD_POOL_SIZE
|
int |
|
quarkus.hibernate-search-standalone.elasticsearch.query.shard-failure.ignore
quarkus.hibernate-search-standalone.elasticsearch."backend-name".query.shard-failure.ignore
Whether partial shard failures are ignored (true ) or lead to Hibernate Search throwing an exception (false ).
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_QUERY_SHARD_FAILURE_IGNORE
|
boolean |
false
|
quarkus.hibernate-search-standalone.elasticsearch.version-check.enabled
quarkus.hibernate-search-standalone.elasticsearch."backend-name".version-check.enabled
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to false if the Elasticsearch cluster may not be available on startup.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_VERSION_CHECK_ENABLED
|
boolean |
true
|
quarkus.hibernate-search-standalone.elasticsearch.schema-management.required-status
quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.required-status
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
quarkus.hibernate-search-standalone.elasticsearch.schema-management.required-status-wait-timeout
quarkus.hibernate-search-standalone.elasticsearch."backend-name".schema-management.required-status-wait-timeout
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration |
10S
|
quarkus.hibernate-search-standalone.elasticsearch.indexing.queue-count
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexing.queue-count
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXING_QUEUE_COUNT
|
int |
10
|
quarkus.hibernate-search-standalone.elasticsearch.indexing.queue-size
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexing.queue-size
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues,
but values that are too low will reduce the likeliness of reaching the max bulk size
and increase the likeliness of application threads blocking because the queue is full,
which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXING_QUEUE_SIZE
|
int |
1000
|
quarkus.hibernate-search-standalone.elasticsearch.indexing.max-bulk-size
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexing.max-bulk-size
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect,
as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXING_MAX_BULK_SIZE
|
int |
100
|
Per-index configuration overrides |
Type |
Default |
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".schema-management.settings-file
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".schema-management.settings-file
Path to a file in the classpath holding custom index settings to be included in the index definition
when creating an Elasticsearch index.
The provided settings will be merged with those generated by Hibernate Search, including analyzer definitions.
When analysis is configured both through an analysis configurer and these custom settings, the behavior is undefined;
it should not be relied upon.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_SETTINGS_FILE
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".schema-management.mapping-file
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".schema-management.mapping-file
Path to a file in the classpath holding a custom index mapping to be included in the index definition
when creating an Elasticsearch index.
The file does not need to (and generally shouldn’t) contain the full mapping:
Hibernate Search will automatically inject missing properties (index fields) in the given mapping.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_MAPPING_FILE
|
string |
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".analysis.configurer
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".analysis.configurer
One or more bean references
to the component(s) used to configure full text analysis (e.g. analyzers, normalizers).
The referenced beans must implement ElasticsearchAnalysisConfigurer .
|
Instead of setting this configuration property,
you can simply annotate your custom ElasticsearchAnalysisConfigurer implementations with @SearchExtension
and leave the configuration property unset: Hibernate Search will use the annotated implementation automatically.
See this section
for more information.
If this configuration property is set, it takes precedence over any @SearchExtension annotation.
|
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__ANALYSIS_CONFIGURER
|
list of string |
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".schema-management.required-status
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".schema-management.required-status
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS
|
|
yellow
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".schema-management.required-status-wait-timeout
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".schema-management.required-status-wait-timeout
How long we should wait for the status before failing the bootstrap.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__SCHEMA_MANAGEMENT_REQUIRED_STATUS_WAIT_TIMEOUT
|
Duration |
10S
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.queue-count
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".indexing.queue-count
The number of indexing queues assigned to each index.
Higher values will lead to more connections being used in parallel,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_COUNT
|
int |
10
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.queue-size
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".indexing.queue-size
The size of indexing queues.
Lower values may lead to lower memory usage, especially if there are many queues,
but values that are too low will reduce the likeliness of reaching the max bulk size
and increase the likeliness of application threads blocking because the queue is full,
which may lead to lower indexing throughput.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_QUEUE_SIZE
|
int |
1000
|
quarkus.hibernate-search-standalone.elasticsearch.indexes."index-name".indexing.max-bulk-size
quarkus.hibernate-search-standalone.elasticsearch."backend-name".indexes."index-name".indexing.max-bulk-size
The maximum size of bulk requests created when processing indexing queues.
Higher values will lead to more documents being sent in each HTTP request sent to Elasticsearch,
which may lead to higher indexing throughput,
but incurs a risk of overloading Elasticsearch,
i.e. of overflowing its HTTP request buffers and tripping
circuit breakers,
leading to Elasticsearch giving up on some request and resulting in indexing failures.
Note that raising this number above the queue size has no effect,
as bulks cannot include more requests than are contained in the queue.
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_ELASTICSEARCH_INDEXES__INDEX_NAME__INDEXING_MAX_BULK_SIZE
|
int |
100
|
Management interface |
Type |
Default |
quarkus.hibernate-search-standalone.management.root-path
Root path for reindexing endpoints.
This value will be resolved as a path relative to ${quarkus.management.root-path} .
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_MANAGEMENT_ROOT_PATH
|
string |
hibernate-search/standalone/
|
quarkus.hibernate-search-standalone.management.enabled
If management interface is turned on the reindexing endpoints will be published under the management interface.
This property allows to enable this functionality by setting it to `true .
Environment variable: QUARKUS_HIBERNATE_SEARCH_STANDALONE_MANAGEMENT_ENABLED
|
boolean |
false
|
Hibernate Validator |
Type |
Default |
quarkus.hibernate-validator.fail-fast
Enable the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_FAIL_FAST
|
boolean |
false
|
Method validation |
Type |
Default |
quarkus.hibernate-validator.method-validation.allow-overriding-parameter-constraints
Define whether overriding methods that override constraints should throw a ConstraintDefinitionException . The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically
In sub types (be it sub classes/interfaces or interface implementations), no parameter constraints may be declared on overridden or implemented methods, nor may parameters be marked for cascaded validation. This would pose a strengthening of preconditions to be fulfilled by the caller.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_OVERRIDING_PARAMETER_CONSTRAINTS
|
boolean |
false
|
quarkus.hibernate-validator.method-validation.allow-parameter-constraints-on-parallel-methods
Define whether parallel methods that define constraints should throw a ConstraintDefinitionException . The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically
If a sub type overrides/implements a method originally defined in several parallel types of the hierarchy (e.g. two interfaces not extending each other, or a class and an interface not implemented by said class), no parameter constraints may be declared for that method at all nor parameters be marked for cascaded validation. This again is to avoid an unexpected strengthening of preconditions to be fulfilled by the caller.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_PARAMETER_CONSTRAINTS_ON_PARALLEL_METHODS
|
boolean |
false
|
quarkus.hibernate-validator.method-validation.allow-multiple-cascaded-validation-on-return-values
Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is false , i.e. do not allow.
See Section 4.5.5 of the JSR 380 specification, specifically
One must not mark a method return value for cascaded validation more than once in a line of a class hierarchy. In other words, overriding methods on sub types (be it sub classes/interfaces or interface implementations) cannot mark the return value for cascaded validation if the return value has already been marked on the overridden method of the super type or interface.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_METHOD_VALIDATION_ALLOW_MULTIPLE_CASCADED_VALIDATION_ON_RETURN_VALUES
|
boolean |
false
|
Expression Language |
Type |
Default |
quarkus.hibernate-validator.expression-language.constraint-expression-feature-level
Configure the Expression Language feature level for constraints, allowing the selection of Expression Language features available for message interpolation.
This property only affects the EL feature level of "static" constraint violation messages set through the message attribute of constraint annotations.
In particular, it doesn’t affect the default EL feature level for custom violations created programmatically in validator implementations. The feature level for those can only be configured directly in the validator implementation.
Environment variable: QUARKUS_HIBERNATE_VALIDATOR_EXPRESSION_LANGUAGE_CONSTRAINT_EXPRESSION_FEATURE_LEVEL
|
default , none , variables , bean-properties , bean-methods
|
bean-properties
|
Infinispan Cache |
Type |
Default |
quarkus.cache.infinispan.client-name
The name of the named Infinispan client to be used for communicating with Infinispan. If not set, use the default Infinispan client.
Environment variable: QUARKUS_CACHE_INFINISPAN_CLIENT_NAME
|
string |
|
quarkus.cache.infinispan.lifespan
The default lifespan of the item stored in the cache
Environment variable: QUARKUS_CACHE_INFINISPAN_LIFESPAN
|
Duration |
|
quarkus.cache.infinispan.max-idle
The default max-idle of the item stored in the cache
Environment variable: QUARKUS_CACHE_INFINISPAN_MAX_IDLE
|
Duration |
|
Additional configuration applied to a specific Infinispan cache (highest precedence) |
Type |
Default |
quarkus.cache.infinispan."cache-name".lifespan
The default lifespan of the item stored in the cache
Environment variable: QUARKUS_CACHE_INFINISPAN__CACHE_NAME__LIFESPAN
|
Duration |
|
quarkus.cache.infinispan."cache-name".max-idle
The default max-idle of the item stored in the cache
Environment variable: QUARKUS_CACHE_INFINISPAN__CACHE_NAME__MAX_IDLE
|
Duration |
|
Infinispan Client |
Type |
Default |
quarkus.infinispan-client.marshaller-class
Sets the marshallerClass. Default is ProtoStreamMarshaller
Environment variable: QUARKUS_INFINISPAN_CLIENT_MARSHALLER_CLASS
|
string |
|
quarkus.infinispan-client.health.enabled
Whether or not a health check is published in case the smallrye-health extension is present.
This is a global setting and is not specific to an Infinispan Client.
Environment variable: QUARKUS_INFINISPAN_CLIENT_HEALTH_ENABLED
|
boolean |
true
|
quarkus.infinispan-client.uri
Sets the URI of the running Infinispan server to connect to. hotrod://localhost:11222@admin:password If provided hosts , username and password will be ignored.
Environment variable: QUARKUS_INFINISPAN_CLIENT_URI
|
string |
|
quarkus.infinispan-client.hosts
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).
Environment variable: QUARKUS_INFINISPAN_CLIENT_HOSTS
|
string |
|
quarkus.infinispan-client.client-intelligence
Sets client intelligence used by authentication Available values: * BASIC - Means that the client doesn’t handle server topology changes and therefore will only use the list of servers supplied at configuration time. * TOPOLOGY_AWARE - Use this provider if you don’t want the client to present any certificates to the remote TLS host. * HASH_DISTRIBUTION_AWARE - Like TOPOLOGY_AWARE but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.
Environment variable: QUARKUS_INFINISPAN_CLIENT_CLIENT_INTELLIGENCE
|
string |
HASH_DISTRIBUTION_AWARE
|
quarkus.infinispan-client.use-auth
Enables or disables authentication. Set it to false when connecting to an Infinispan Server without authentication. deployments. Default is 'true'.
Environment variable: QUARKUS_INFINISPAN_CLIENT_USE_AUTH
|
boolean |
true
|
quarkus.infinispan-client.username
Sets username used by authentication.
Environment variable: QUARKUS_INFINISPAN_CLIENT_USERNAME
|
string |
|
quarkus.infinispan-client.password
Sets password used by authentication.
Environment variable: QUARKUS_INFINISPAN_CLIENT_PASSWORD
|
string |
|
quarkus.infinispan-client.auth-realm
Sets realm used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_REALM
|
string |
default
|
quarkus.infinispan-client.auth-server-name
Sets server name used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT_AUTH_SERVER_NAME
|
string |
infinispan
|
quarkus.infinispan-client.sasl-mechanism
Sets SASL mechanism used by authentication. Available values: * DIGEST-MD5 - Uses the MD5 hashing algorithm in addition to nonces to encrypt credentials. This is the default. * EXTERNAL - Uses client certificates to provide valid identities to Infinispan Server and enable encryption. * PLAIN - Sends credentials in plain text (unencrypted) over the wire in a way that is similar to HTTP BASIC authentication. You should use PLAIN authentication only in combination with TLS encryption.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SASL_MECHANISM
|
string |
DIGEST-MD5
|
quarkus.infinispan-client.trust-store
Specifies the filename of a truststore to use to create the SSLContext . You also need to specify a trustStorePassword. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE
|
string |
|
quarkus.infinispan-client.trust-store-password
Specifies the password needed to open the truststore You also need to specify a trustStore. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE_PASSWORD
|
string |
|
quarkus.infinispan-client.trust-store-type
Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS if trustStore is enabled.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRUST_STORE_TYPE
|
string |
|
quarkus.infinispan-client.ssl-protocol
Configures the secure socket protocol. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SSL_PROTOCOL
|
string |
|
quarkus.infinispan-client.ssl-provider
Sets the ssl provider. For example BCFIPS Setting this implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SSL_PROVIDER
|
string |
|
quarkus.infinispan-client.ssl-ciphers
Configures the ciphers. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SSL_CIPHERS
|
list of string |
|
quarkus.infinispan-client.ssl-host-name-validation
Do SSL hostname validation. Defaults to true.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SSL_HOST_NAME_VALIDATION
|
boolean |
|
quarkus.infinispan-client.sni-host-name
SNI host name. Mandatory when SSL is enabled and host name validation is true.
Environment variable: QUARKUS_INFINISPAN_CLIENT_SNI_HOST_NAME
|
string |
|
quarkus.infinispan-client.tracing.propagation.enabled
Whether a tracing propagation is enabled in case the Opentelemetry extension is present. By default the propagation of the context is propagated from the client to the Infinispan Server.
Environment variable: QUARKUS_INFINISPAN_CLIENT_TRACING_PROPAGATION_ENABLED
|
boolean |
|
quarkus.infinispan-client.use-schema-registration
Enables or disables Protobuf generated schemas upload to the server. Set it to 'false' when you need to handle the lifecycle of the Protobuf Schemas on Server side yourself. Default is 'true'. This is a global setting and is not specific to a Infinispan Client.
Environment variable: QUARKUS_INFINISPAN_CLIENT_USE_SCHEMA_REGISTRATION
|
boolean |
true
|
quarkus.infinispan-client.cache."cache".configuration-resource
Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__CONFIGURATION_RESOURCE
|
string |
|
quarkus.infinispan-client.cache."cache".configuration
Cache configuration in inlined XML to create the cache on first access. Will be ignored if the configuration-uri is provided for the same cache name. An example of the user defined property: quarkus.infinispan-client.cache.bookscache.configuration=
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__CONFIGURATION
|
string |
|
quarkus.infinispan-client.cache."cache".configuration-uri
Cache configuration file in XML, Json or YAML whose path will be converted to URI to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-uri=cacheConfig.xml
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__CONFIGURATION_URI
|
string |
|
quarkus.infinispan-client.cache."cache".near-cache-max-entries
The maximum number of entries to keep locally for the specified cache.
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__NEAR_CACHE_MAX_ENTRIES
|
int |
|
quarkus.infinispan-client.cache."cache".near-cache-mode
Sets near cache mode used by the Infinispan Client Available values: * DISABLED - Means that near caching is disabled. This is the default value. * INVALIDATED - Means is near caching is invalidated, so when entries are updated or removed server-side, invalidation messages will be sent to clients to remove them from the near cache.
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__NEAR_CACHE_MODE
|
|
|
quarkus.infinispan-client.cache."cache".near-cache-use-bloom-filter
Enables bloom filter for near caching. Bloom filters optimize performance for write operations by reducing the total number of invalidation messages.
Environment variable: QUARKUS_INFINISPAN_CLIENT_CACHE__CACHE__NEAR_CACHE_USE_BLOOM_FILTER
|
boolean |
|
quarkus.infinispan-client.backup-cluster."backup-cluster".hosts
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. hostA:11222;hostB:11222).
Environment variable: QUARKUS_INFINISPAN_CLIENT_BACKUP_CLUSTER__BACKUP_CLUSTER__HOSTS
|
string |
required |
quarkus.infinispan-client.backup-cluster."backup-cluster".client-intelligence
Sets client intelligence used by authentication Available values: * BASIC - Means that the client doesn’t handle server topology changes and therefore will only use the list of servers supplied at configuration time. * TOPOLOGY_AWARE - Use this provider if you don’t want the client to present any certificates to the remote TLS host. * HASH_DISTRIBUTION_AWARE - Like TOPOLOGY_AWARE but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.
Environment variable: QUARKUS_INFINISPAN_CLIENT_BACKUP_CLUSTER__BACKUP_CLUSTER__CLIENT_INTELLIGENCE
|
string |
HASH_DISTRIBUTION_AWARE
|
quarkus.infinispan-client.backup-cluster."backup-cluster".use-schema-registration
Enables or disables Protobuf generated schemas upload to the backup. Set it to 'false' when you need to handle the lifecycle of the Protobuf Schemas on Server side yourself. Default is 'true'. This setting will be ignored if the Global Setting is set up to false.
Environment variable: QUARKUS_INFINISPAN_CLIENT_BACKUP_CLUSTER__BACKUP_CLUSTER__USE_SCHEMA_REGISTRATION
|
boolean |
true
|
Named clients |
Type |
Default |
quarkus.infinispan-client."client-name".marshaller-class
Sets the marshallerClass. Default is ProtoStreamMarshaller
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__MARSHALLER_CLASS
|
string |
|
quarkus.infinispan-client."client-name".cache."cache".configuration-resource
Cache configuration file in XML, JSON or YAML is defined in build time to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-resource=cacheConfig.xml
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__CONFIGURATION_RESOURCE
|
string |
|
quarkus.infinispan-client."client-name".uri
Sets the URI of the running Infinispan server to connect to. hotrod://localhost:11222@admin:password If provided hosts , username and password will be ignored.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__URI
|
string |
|
quarkus.infinispan-client."client-name".hosts
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222).
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__HOSTS
|
string |
|
quarkus.infinispan-client."client-name".client-intelligence
Sets client intelligence used by authentication Available values: * BASIC - Means that the client doesn’t handle server topology changes and therefore will only use the list of servers supplied at configuration time. * TOPOLOGY_AWARE - Use this provider if you don’t want the client to present any certificates to the remote TLS host. * HASH_DISTRIBUTION_AWARE - Like TOPOLOGY_AWARE but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CLIENT_INTELLIGENCE
|
string |
HASH_DISTRIBUTION_AWARE
|
quarkus.infinispan-client."client-name".use-auth
Enables or disables authentication. Set it to false when connecting to an Infinispan Server without authentication. deployments. Default is 'true'.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__USE_AUTH
|
boolean |
true
|
quarkus.infinispan-client."client-name".username
Sets username used by authentication.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__USERNAME
|
string |
|
quarkus.infinispan-client."client-name".password
Sets password used by authentication.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__PASSWORD
|
string |
|
quarkus.infinispan-client."client-name".auth-realm
Sets realm used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__AUTH_REALM
|
string |
default
|
quarkus.infinispan-client."client-name".auth-server-name
Sets server name used by authentication
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__AUTH_SERVER_NAME
|
string |
infinispan
|
quarkus.infinispan-client."client-name".sasl-mechanism
Sets SASL mechanism used by authentication. Available values: * DIGEST-MD5 - Uses the MD5 hashing algorithm in addition to nonces to encrypt credentials. This is the default. * EXTERNAL - Uses client certificates to provide valid identities to Infinispan Server and enable encryption. * PLAIN - Sends credentials in plain text (unencrypted) over the wire in a way that is similar to HTTP BASIC authentication. You should use PLAIN authentication only in combination with TLS encryption.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SASL_MECHANISM
|
string |
DIGEST-MD5
|
quarkus.infinispan-client."client-name".trust-store
Specifies the filename of a truststore to use to create the SSLContext . You also need to specify a trustStorePassword. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__TRUST_STORE
|
string |
|
quarkus.infinispan-client."client-name".trust-store-password
Specifies the password needed to open the truststore You also need to specify a trustStore. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__TRUST_STORE_PASSWORD
|
string |
|
quarkus.infinispan-client."client-name".trust-store-type
Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS if trustStore is enabled.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__TRUST_STORE_TYPE
|
string |
|
quarkus.infinispan-client."client-name".ssl-protocol
Configures the secure socket protocol. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SSL_PROTOCOL
|
string |
|
quarkus.infinispan-client."client-name".ssl-provider
Sets the ssl provider. For example BCFIPS Setting this implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SSL_PROVIDER
|
string |
|
quarkus.infinispan-client."client-name".ssl-ciphers
Configures the ciphers. Setting this property implicitly enables SSL/TLS.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SSL_CIPHERS
|
list of string |
|
quarkus.infinispan-client."client-name".ssl-host-name-validation
Do SSL hostname validation. Defaults to true.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SSL_HOST_NAME_VALIDATION
|
boolean |
|
quarkus.infinispan-client."client-name".sni-host-name
SNI host name. Mandatory when SSL is enabled and host name validation is true.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__SNI_HOST_NAME
|
string |
|
quarkus.infinispan-client."client-name".tracing.propagation.enabled
Whether a tracing propagation is enabled in case the Opentelemetry extension is present. By default the propagation of the context is propagated from the client to the Infinispan Server.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__TRACING_PROPAGATION_ENABLED
|
boolean |
|
quarkus.infinispan-client."client-name".cache."cache".configuration
Cache configuration in inlined XML to create the cache on first access. Will be ignored if the configuration-uri is provided for the same cache name. An example of the user defined property: quarkus.infinispan-client.cache.bookscache.configuration=
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__CONFIGURATION
|
string |
|
quarkus.infinispan-client."client-name".cache."cache".configuration-uri
Cache configuration file in XML, Json or YAML whose path will be converted to URI to create the cache on first access. An example of the user defined property. cacheConfig.xml file is located in the 'resources' folder: quarkus.infinispan-client.cache.bookscache.configuration-uri=cacheConfig.xml
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__CONFIGURATION_URI
|
string |
|
quarkus.infinispan-client."client-name".cache."cache".near-cache-max-entries
The maximum number of entries to keep locally for the specified cache.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__NEAR_CACHE_MAX_ENTRIES
|
int |
|
quarkus.infinispan-client."client-name".cache."cache".near-cache-mode
Sets near cache mode used by the Infinispan Client Available values: * DISABLED - Means that near caching is disabled. This is the default value. * INVALIDATED - Means is near caching is invalidated, so when entries are updated or removed server-side, invalidation messages will be sent to clients to remove them from the near cache.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__NEAR_CACHE_MODE
|
|
|
quarkus.infinispan-client."client-name".cache."cache".near-cache-use-bloom-filter
Enables bloom filter for near caching. Bloom filters optimize performance for write operations by reducing the total number of invalidation messages.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__CACHE__CACHE__NEAR_CACHE_USE_BLOOM_FILTER
|
boolean |
|
quarkus.infinispan-client."client-name".backup-cluster."backup-cluster".hosts
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. hostA:11222;hostB:11222).
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__BACKUP_CLUSTER__BACKUP_CLUSTER__HOSTS
|
string |
required |
quarkus.infinispan-client."client-name".backup-cluster."backup-cluster".client-intelligence
Sets client intelligence used by authentication Available values: * BASIC - Means that the client doesn’t handle server topology changes and therefore will only use the list of servers supplied at configuration time. * TOPOLOGY_AWARE - Use this provider if you don’t want the client to present any certificates to the remote TLS host. * HASH_DISTRIBUTION_AWARE - Like TOPOLOGY_AWARE but with the additional advantage that each request involving keys will be routed to the server who is the primary owner which improves performance greatly. This is the default.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__BACKUP_CLUSTER__BACKUP_CLUSTER__CLIENT_INTELLIGENCE
|
string |
HASH_DISTRIBUTION_AWARE
|
quarkus.infinispan-client."client-name".backup-cluster."backup-cluster".use-schema-registration
Enables or disables Protobuf generated schemas upload to the backup. Set it to 'false' when you need to handle the lifecycle of the Protobuf Schemas on Server side yourself. Default is 'true'. This setting will be ignored if the Global Setting is set up to false.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__BACKUP_CLUSTER__BACKUP_CLUSTER__USE_SCHEMA_REGISTRATION
|
boolean |
true
|
Dev Services |
Type |
Default |
quarkus.infinispan-client."client-name".devservices.enabled
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_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.infinispan-client."client-name".devservices.create-default-client
When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_CREATE_DEFAULT_CLIENT
|
boolean |
true
|
quarkus.infinispan-client."client-name".devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_PORT
|
int |
|
quarkus.infinispan-client."client-name".devservices.shared
Indicates if the Infinispan 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 Infinispan starts a new container.
The discovery uses the quarkus-dev-service-infinispan label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.infinispan-client."client-name".devservices.service-name
The value of the quarkus-dev-service-infinispan 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 Infinispan looks for a container with the quarkus-dev-service-infinispan 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-infinispan label set to the specified value.
This property is used when you need multiple shared Infinispan servers.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_SERVICE_NAME
|
string |
infinispan
|
quarkus.infinispan-client."client-name".devservices.image-name
The image to use. Note that only official Infinispan images are supported.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.infinispan-client."client-name".devservices.artifacts
List of the artifacts to automatically download and add to the Infinispan server libraries.
For example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.
If an invalid value is passed, the Infinispan server will throw an error when trying to start.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_ARTIFACTS
|
list of string |
|
quarkus.infinispan-client."client-name".devservices.site
Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure mcast-port to avoid forming a cluster with any other running Infinispan Server container.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_SITE
|
string |
|
quarkus.infinispan-client."client-name".devservices.mcast-port
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_MCAST_PORT
|
int |
|
quarkus.infinispan-client."client-name".devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.infinispan-client."client-name".devservices.config-files
Infinispan Server configuration chunks to be passed to the container.
Environment variable: QUARKUS_INFINISPAN_CLIENT__CLIENT_NAME__DEVSERVICES_CONFIG_FILES
|
list of string |
|
Dev Services |
Type |
Default |
quarkus.infinispan-client.devservices.enabled
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_INFINISPAN_CLIENT_DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.infinispan-client.devservices.create-default-client
When the configuration is empty, an Infinispan default client is automatically created to connect to the running dev service. However, there are scenarios where creating this client is unnecessary, yet we still need to spin up an Infinispan Server. In such cases, this property serves to determine whether the client should be created by default or not by the extension.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CREATE_DEFAULT_CLIENT
|
boolean |
true
|
quarkus.infinispan-client.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_PORT
|
int |
|
quarkus.infinispan-client.devservices.shared
Indicates if the Infinispan 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 Infinispan starts a new container.
The discovery uses the quarkus-dev-service-infinispan label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.infinispan-client.devservices.service-name
The value of the quarkus-dev-service-infinispan 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 Infinispan looks for a container with the quarkus-dev-service-infinispan 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-infinispan label set to the specified value.
This property is used when you need multiple shared Infinispan servers.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SERVICE_NAME
|
string |
infinispan
|
quarkus.infinispan-client.devservices.image-name
The image to use. Note that only official Infinispan images are supported.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.infinispan-client.devservices.artifacts
List of the artifacts to automatically download and add to the Infinispan server libraries.
For example a Maven coordinate (org.postgresql:postgresql:42.3.1) or a dependency location url.
If an invalid value is passed, the Infinispan server will throw an error when trying to start.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_ARTIFACTS
|
list of string |
|
quarkus.infinispan-client.devservices.site
Add a site name to start the Infinispan Server Container with Cross Site Replication enabled (ex. lon). Cross Site Replication is the capability to connect two separate Infinispan Server Clusters that might run in different Data Centers, and configure backup caches to copy the data across the clusters with active-active or active-passive replication. See more about Cross Site Replication in the Infinispan Documentation https://infinispan.org/docs/stable/titles/xsite/xsite.html Configure mcast-port to avoid forming a cluster with any other running Infinispan Server container.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_SITE
|
string |
|
quarkus.infinispan-client.devservices.mcast-port
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_MCAST_PORT
|
int |
|
quarkus.infinispan-client.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.infinispan-client.devservices.config-files
Infinispan Server configuration chunks to be passed to the container.
Environment variable: QUARKUS_INFINISPAN_CLIENT_DEVSERVICES_CONFIG_FILES
|
list of string |
|
Info |
Type |
Default |
Whether the info endpoint will be enabled
Environment variable: QUARKUS_INFO_ENABLED
|
boolean |
true
|
The path under which the info endpoint will be located
Environment variable: QUARKUS_INFO_PATH
|
string |
info
|
Whether git info will be included in the info endpoint
Environment variable: QUARKUS_INFO_GIT_ENABLED
|
boolean |
true
|
Controls how much information is present in the git section
Environment variable: QUARKUS_INFO_GIT_MODE
|
|
standard
|
quarkus.info.build.enabled
Whether build info will be included in the info endpoint
Environment variable: QUARKUS_INFO_BUILD_ENABLED
|
boolean |
true
|
quarkus.info.build."property-key"
Additional properties to be added to the build section
Environment variable: QUARKUS_INFO_BUILD__PROPERTY_KEY_
|
Map<String,String> |
|
Whether os info will be included in the info endpoint
Environment variable: QUARKUS_INFO_OS_ENABLED
|
boolean |
true
|
quarkus.info.java.enabled
Whether java info will be included in the info endpoint
Environment variable: QUARKUS_INFO_JAVA_ENABLED
|
boolean |
true
|
Jackson |
Type |
Default |
quarkus.jackson.fail-on-unknown-properties
If enabled, Jackson will fail when encountering unknown properties.
You can still override it locally with @JsonIgnoreProperties(ignoreUnknown = false) .
Environment variable: QUARKUS_JACKSON_FAIL_ON_UNKNOWN_PROPERTIES
|
boolean |
false
|
quarkus.jackson.fail-on-empty-beans
If enabled, Jackson will fail when no accessors are found for a type. This is enabled by default to match the default Jackson behavior.
Environment variable: QUARKUS_JACKSON_FAIL_ON_EMPTY_BEANS
|
boolean |
true
|
quarkus.jackson.write-dates-as-timestamps
If enabled, Jackson will serialize dates as numeric value(s). When disabled, they are serialized in ISO 8601 format.
Environment variable: QUARKUS_JACKSON_WRITE_DATES_AS_TIMESTAMPS
|
boolean |
false
|
quarkus.jackson.write-durations-as-timestamps
If enabled, Jackson will serialize durations as numeric value(s). When disabled, they are serialized in ISO 8601 format. This is enabled by default to match the default Jackson behavior.
Environment variable: QUARKUS_JACKSON_WRITE_DURATIONS_AS_TIMESTAMPS
|
boolean |
true
|
quarkus.jackson.accept-case-insensitive-enums
If enabled, Jackson will ignore case during Enum deserialization.
Environment variable: QUARKUS_JACKSON_ACCEPT_CASE_INSENSITIVE_ENUMS
|
boolean |
false
|
If set, Jackson will default to using the specified timezone when formatting dates. Some examples values are "Asia/Jakarta" and "GMT+3". If not set, Jackson will use its own default.
Environment variable: QUARKUS_JACKSON_TIMEZONE
|
ZoneId |
UTC
|
quarkus.jackson.serialization-inclusion
Define which properties of Java Beans are to be included in serialization.
Environment variable: QUARKUS_JACKSON_SERIALIZATION_INCLUSION
|
always , non-null , non-absent , non-empty , non-default , custom , use-defaults
|
|
quarkus.jackson.property-naming-strategy
Defines how names of JSON properties ("external names") are derived from names of POJO methods and fields ("internal names"). The value can be one of the one of the constants in com.fasterxml.jackson.databind.PropertyNamingStrategies , so for example, LOWER_CAMEL_CASE or UPPER_CAMEL_CASE . The value can also be a fully qualified class name of a com.fasterxml.jackson.databind.PropertyNamingStrategy subclass.
Environment variable: QUARKUS_JACKSON_PROPERTY_NAMING_STRATEGY
|
string |
|
Jacoco - Code Coverage |
Type |
Default |
Whether or not the jacoco extension is enabled.
Environment variable: QUARKUS_JACOCO_ENABLED
|
boolean |
true
|
The jacoco data file. The path can be relative (to the module) or absolute.
Environment variable: QUARKUS_JACOCO_DATA_FILE
|
string |
target/jacoco-quarkus.exec
|
quarkus.jacoco.reuse-data-file
Whether to reuse (true ) or delete (false ) the jacoco data file on each run.
Environment variable: QUARKUS_JACOCO_REUSE_DATA_FILE
|
boolean |
false
|
If Quarkus should generate the Jacoco report
Environment variable: QUARKUS_JACOCO_REPORT
|
boolean |
true
|
quarkus.jacoco.output-encoding
Encoding of the generated reports.
Environment variable: QUARKUS_JACOCO_OUTPUT_ENCODING
|
string |
UTF-8
|
Name of the root node HTML report pages.
Environment variable: QUARKUS_JACOCO_TITLE
|
string |
${quarkus.application.name}
|
Footer text used in HTML report pages.
Environment variable: QUARKUS_JACOCO_FOOTER
|
string |
|
quarkus.jacoco.source-encoding
Encoding of the source files.
Environment variable: QUARKUS_JACOCO_SOURCE_ENCODING
|
string |
UTF-8
|
A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.
-
**/fo/**/* targets all classes under fo and sub packages
-
**/bar/* targets all classes directly under bar
-
**/*BAR*.class targets classes that contain BAR in their name regardless of path
Environment variable: QUARKUS_JACOCO_INCLUDES
|
list of string |
**
|
A list of class files to exclude from the report. May use wildcard characters (* and ?). When not specified nothing will be excluded.
-
**/fo/**/* targets all classes under fo and sub packages
-
**/bar/* targets all classes directly under bar
-
**/*BAR*.class targets classes that contain BAR in their name regardless of path
Environment variable: QUARKUS_JACOCO_EXCLUDES
|
list of string |
|
quarkus.jacoco.report-location
The location of the report files. The path can be relative (to the module) or absolute.
Environment variable: QUARKUS_JACOCO_REPORT_LOCATION
|
string |
target/jacoco-report
|
Java Flight Recorder (JFR) |
Type |
Default |
If false, only quarkus-jfr events are not recorded even if JFR is enabled. In this case, Java standard API and virtual machine information will be recorded according to the setting. Default value is true
Environment variable: QUARKUS_JFR_ENABLED
|
boolean |
true
|
If false, only REST events in quarkus-jfr are not recorded even if JFR is enabled. In this case, other quarkus-jfr, Java standard API and virtual machine information will be recorded according to the setting. Default value is true
Environment variable: QUARKUS_JFR_REST_ENABLED
|
boolean |
true
|
JAXB |
Type |
Default |
quarkus.jaxb.validate-jaxb-context
If enabled, it will validate the default JAXB context at build time.
Environment variable: QUARKUS_JAXB_VALIDATE_JAXB_CONTEXT
|
boolean |
false
|
quarkus.jaxb.exclude-classes
Exclude classes to automatically be bound to the default JAXB context. Values with suffix .* , i.e. org.acme.* , are considered packages and exclude all classes that are members of these packages
Environment variable: QUARKUS_JAXB_EXCLUDE_CLASSES
|
list of string |
|
Kafka - Client |
Type |
Default |
quarkus.kafka.health.enabled
Whether a health check is published in case the smallrye-health extension is present.
If you enable the health check, you must specify the kafka.bootstrap.servers property.
Environment variable: QUARKUS_KAFKA_HEALTH_ENABLED
|
boolean |
false
|
quarkus.kafka.snappy.enabled
Whether to enable Snappy in native mode.
Note that Snappy requires GraalVM 21+ and embeds a native library in the native executable. This library is unpacked and loaded when the application starts.
Environment variable: QUARKUS_KAFKA_SNAPPY_ENABLED
|
boolean |
false
|
quarkus.kafka.snappy.load-from-shared-classloader
Whether to load the Snappy native library from the shared classloader. This setting is only used in tests if the tests are using different profiles, which would lead to unsatisfied link errors when loading Snappy.
Environment variable: QUARKUS_KAFKA_SNAPPY_LOAD_FROM_SHARED_CLASSLOADER
|
boolean |
false
|
Dev Services |
Type |
Default |
quarkus.kafka.devservices.enabled
If Dev Services for Kafka has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Kafka, Dev Services starts a broker unless kafka.bootstrap.servers is set or if all the Reactive Messaging Kafka channel are configured with a bootstrap.servers .
Environment variable: QUARKUS_KAFKA_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.kafka.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_PORT
|
int |
|
quarkus.kafka.devservices.provider
Kafka dev service container type.
Redpanda, Strimzi and kafka-native container providers are supported. Default is redpanda.
Note that Strimzi and Kafka Native images are launched in Kraft mode.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_PROVIDER
|
redpanda , strimzi , kafka-native
|
redpanda
|
quarkus.kafka.devservices.image-name
The Kafka container image to use.
Dependent on the provider.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.kafka.devservices.shared
Indicates if the Kafka broker 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 Kafka starts a new container.
The discovery uses the quarkus-dev-service-kafka label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.kafka.devservices.service-name
The value of the quarkus-dev-service-kafka 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 Kafka looks for a container with the quarkus-dev-service-kafka 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-kafka label set to the specified value.
This property is used when you need multiple shared Kafka brokers.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_SERVICE_NAME
|
string |
kafka
|
quarkus.kafka.devservices.topic-partitions."topic-name"
The topic-partition pairs to create in the Dev Services Kafka broker. After the broker is started, given topics with partitions are created, skipping already existing topics. For example, quarkus.kafka.devservices.topic-partitions.test=2 will create a topic named test with 2 partitions.
The topic creation will not try to re-partition existing topics with different number of partitions.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS__TOPIC_NAME_
|
Map<String,Integer> |
|
quarkus.kafka.devservices.topic-partitions-timeout
Timeout for admin client calls used in topic creation.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_TOPIC_PARTITIONS_TIMEOUT
|
Duration |
2S
|
quarkus.kafka.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.kafka.devservices.redpanda.transaction-enabled
Environment variable: QUARKUS_KAFKA_DEVSERVICES_REDPANDA_TRANSACTION_ENABLED
|
boolean |
true
|
quarkus.kafka.devservices.redpanda.proxy-port
Port to access the Redpanda HTTP Proxy (pandaproxy).
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_KAFKA_DEVSERVICES_REDPANDA_PROXY_PORT
|
int |
|
Kafka Streams |
Type |
Default |
quarkus.kafka-streams.health.enabled
Whether a health check is published in case the smallrye-health extension is present (defaults to true).
Environment variable: QUARKUS_KAFKA_STREAMS_HEALTH_ENABLED
|
boolean |
true
|
quarkus.kafka-streams.application-id
A unique identifier for this Kafka Streams application. If not set, defaults to quarkus.application.name.
Environment variable: QUARKUS_KAFKA_STREAMS_APPLICATION_ID
|
string |
${quarkus.application.name}
|
quarkus.kafka-streams.bootstrap-servers
A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s). If not set, fallback to kafka.bootstrap.servers , and if not set either use localhost:9092 .
Environment variable: QUARKUS_KAFKA_STREAMS_BOOTSTRAP_SERVERS
|
list of host:port |
localhost:9092
|
quarkus.kafka-streams.application-server
A unique identifier of this application instance, typically in the form host:port.
Environment variable: QUARKUS_KAFKA_STREAMS_APPLICATION_SERVER
|
string |
|
quarkus.kafka-streams.topics
A comma-separated list of topic names. The pipeline will only be started once all these topics are present in the Kafka cluster and ignore.topics is set to false.
Environment variable: QUARKUS_KAFKA_STREAMS_TOPICS
|
list of string |
|
quarkus.kafka-streams.topics-timeout
Timeout to wait for topic names to be returned from admin client. If set to 0 (or negative), topics check is ignored.
Environment variable: QUARKUS_KAFKA_STREAMS_TOPICS_TIMEOUT
|
Duration |
10S
|
quarkus.kafka-streams.schema-registry-key
The schema registry key. Different schema registry libraries expect a registry URL in different configuration properties. For Apicurio Registry, use apicurio.registry.url . For Confluent schema registry, use schema.registry.url .
Environment variable: QUARKUS_KAFKA_STREAMS_SCHEMA_REGISTRY_KEY
|
string |
schema.registry.url
|
quarkus.kafka-streams.schema-registry-url
Environment variable: QUARKUS_KAFKA_STREAMS_SCHEMA_REGISTRY_URL
|
string |
|
quarkus.kafka-streams.security.protocol
Environment variable: QUARKUS_KAFKA_STREAMS_SECURITY_PROTOCOL
|
string |
|
quarkus.kafka-streams.sasl.mechanism
SASL mechanism used for client connections
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_MECHANISM
|
string |
|
quarkus.kafka-streams.sasl.jaas-config
JAAS login context parameters for SASL connections in the format used by JAAS configuration files
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_JAAS_CONFIG
|
string |
|
quarkus.kafka-streams.sasl.client-callback-handler-class
The fully qualified name of a SASL client callback handler class
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_CLIENT_CALLBACK_HANDLER_CLASS
|
string |
|
quarkus.kafka-streams.sasl.login-callback-handler-class
The fully qualified name of a SASL login callback handler class
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_CALLBACK_HANDLER_CLASS
|
string |
|
quarkus.kafka-streams.sasl.login-class
The fully qualified name of a class that implements the Login interface
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_CLASS
|
string |
|
quarkus.kafka-streams.sasl.kerberos-service-name
The Kerberos principal name that Kafka runs as
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_SERVICE_NAME
|
string |
|
quarkus.kafka-streams.sasl.kerberos-kinit-cmd
Kerberos kinit command path
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_KINIT_CMD
|
string |
|
quarkus.kafka-streams.sasl.kerberos-ticket-renew-window-factor
Login thread will sleep until the specified window factor of time from last refresh
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_TICKET_RENEW_WINDOW_FACTOR
|
double |
|
quarkus.kafka-streams.sasl.kerberos-ticket-renew-jitter
Percentage of random jitter added to the renewal time
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_TICKET_RENEW_JITTER
|
double |
|
quarkus.kafka-streams.sasl.kerberos-min-time-before-relogin
Percentage of random jitter added to the renewal time
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_KERBEROS_MIN_TIME_BEFORE_RELOGIN
|
long |
|
quarkus.kafka-streams.sasl.login-refresh-window-factor
Login refresh thread will sleep until the specified window factor relative to the credential’s lifetime has been reached-
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_WINDOW_FACTOR
|
double |
|
quarkus.kafka-streams.sasl.login-refresh-window-jitter
The maximum amount of random jitter relative to the credential’s lifetime
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_WINDOW_JITTER
|
double |
|
quarkus.kafka-streams.sasl.login-refresh-min-period
The desired minimum duration for the login refresh thread to wait before refreshing a credential
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_MIN_PERIOD
|
Duration |
|
quarkus.kafka-streams.sasl.login-refresh-buffer
The amount of buffer duration before credential expiration to maintain when refreshing a credential
Environment variable: QUARKUS_KAFKA_STREAMS_SASL_LOGIN_REFRESH_BUFFER
|
Duration |
|
quarkus.kafka-streams.ssl.protocol
The SSL protocol used to generate the SSLContext
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_PROTOCOL
|
string |
|
quarkus.kafka-streams.ssl.provider
The name of the security provider used for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_PROVIDER
|
string |
|
quarkus.kafka-streams.ssl.cipher-suites
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_CIPHER_SUITES
|
string |
|
quarkus.kafka-streams.ssl.enabled-protocols
The list of protocols enabled for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_ENABLED_PROTOCOLS
|
string |
|
quarkus.kafka-streams.ssl.truststore.type
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_TYPE
|
string |
|
quarkus.kafka-streams.ssl.truststore.location
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_LOCATION
|
string |
|
quarkus.kafka-streams.ssl.truststore.password
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_PASSWORD
|
string |
|
quarkus.kafka-streams.ssl.truststore.certificates
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTSTORE_CERTIFICATES
|
string |
|
quarkus.kafka-streams.ssl.keystore.type
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_TYPE
|
string |
|
quarkus.kafka-streams.ssl.keystore.location
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_LOCATION
|
string |
|
quarkus.kafka-streams.ssl.keystore.password
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_PASSWORD
|
string |
|
quarkus.kafka-streams.ssl.keystore.key
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_KEY
|
string |
|
quarkus.kafka-streams.ssl.keystore.certificate-chain
Key store certificate chain
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYSTORE_CERTIFICATE_CHAIN
|
string |
|
quarkus.kafka-streams.ssl.key.password
Password of the private key in the key store
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEY_PASSWORD
|
string |
|
quarkus.kafka-streams.ssl.keymanager-algorithm
The algorithm used by key manager factory for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_KEYMANAGER_ALGORITHM
|
string |
|
quarkus.kafka-streams.ssl.trustmanager-algorithm
The algorithm used by trust manager factory for SSL connections
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_TRUSTMANAGER_ALGORITHM
|
string |
|
quarkus.kafka-streams.ssl.endpoint-identification-algorithm
The endpoint identification algorithm to validate server hostname using server certificate
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM
|
string |
https
|
quarkus.kafka-streams.ssl.secure-random-implementation
The SecureRandom PRNG implementation to use for SSL cryptography operations
Environment variable: QUARKUS_KAFKA_STREAMS_SSL_SECURE_RANDOM_IMPLEMENTATION
|
string |
|
Keycloak Admin Client - Common |
Type |
Default |
quarkus.keycloak.admin-client.enabled
Set to true if Keycloak Admin Client injection is supported.
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_ENABLED
|
boolean |
true
|
quarkus.keycloak.admin-client.server-url
Keycloak server URL, for example, https://host:port . If this property is not set then the Keycloak Admin Client injection will fail - use org.keycloak.admin.client.KeycloakBuilder to create it instead.
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_SERVER_URL
|
string |
|
quarkus.keycloak.admin-client.realm
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_REALM
|
string |
master
|
quarkus.keycloak.admin-client.client-id
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_CLIENT_ID
|
string |
admin-cli
|
quarkus.keycloak.admin-client.client-secret
Client secret. Required with a client_credentials grant type.
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_CLIENT_SECRET
|
string |
|
quarkus.keycloak.admin-client.username
Username. Required with a password grant type.
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_USERNAME
|
string |
admin
|
quarkus.keycloak.admin-client.password
Password. Required with a password grant type.
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_PASSWORD
|
string |
admin
|
quarkus.keycloak.admin-client.scope
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_SCOPE
|
string |
|
quarkus.keycloak.admin-client.grant-type
Environment variable: QUARKUS_KEYCLOAK_ADMIN_CLIENT_GRANT_TYPE
|
password , client-credentials
|
password
|
Keycloak Authorization |
Type |
Default |
quarkus.keycloak.policy-enforcer.enable
Enables policy enforcement.
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_ENABLE
|
boolean |
false
|
quarkus.keycloak.connection-pool-size
Adapters will make separate HTTP invocations to the Keycloak server to turn an access code into an access token. This config option defines how many connections to the Keycloak server should be pooled
Environment variable: QUARKUS_KEYCLOAK_CONNECTION_POOL_SIZE
|
int |
20
|
quarkus.keycloak.policy-enforcer.enforcement-mode
Specifies how policies are enforced.
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_ENFORCEMENT_MODE
|
permissive , enforcing , disabled
|
enforcing
|
quarkus.keycloak.policy-enforcer.path-cache.max-entries
Defines the limit of entries that should be kept in the cache
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATH_CACHE_MAX_ENTRIES
|
int |
1000
|
quarkus.keycloak.policy-enforcer.path-cache.lifespan
Defines the time in milliseconds when the entry should be expired
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATH_CACHE_LIFESPAN
|
long |
30000
|
quarkus.keycloak.policy-enforcer.lazy-load-paths
Specifies how the adapter should fetch the server for resources associated with paths in your application. If true, the policy enforcer is going to fetch resources on-demand accordingly with the path being requested
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_LAZY_LOAD_PATHS
|
boolean |
true
|
quarkus.keycloak.policy-enforcer.claim-information-point."complex-config"
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_CLAIM_INFORMATION_POINT__COMPLEX_CONFIG_
|
Map<String,Map<String,Map<String,String>>> |
|
quarkus.keycloak.policy-enforcer.claim-information-point."simple-config"
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_CLAIM_INFORMATION_POINT__SIMPLE_CONFIG_
|
Map<String,Map<String,String>> |
|
quarkus.keycloak.policy-enforcer.http-method-as-scope
Specifies how scopes should be mapped to HTTP methods. If set to true, the policy enforcer will use the HTTP method from the current request to check whether access should be granted
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_HTTP_METHOD_AS_SCOPE
|
boolean |
false
|
quarkus.keycloak.policy-enforcer.paths."paths".name
The name of a resource on the server that is to be associated with a given path
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__NAME
|
string |
|
quarkus.keycloak.policy-enforcer.paths."paths".paths
HTTP request paths that should be protected by the policy enforcer
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__PATHS
|
list of string |
|
quarkus.keycloak.policy-enforcer.paths."paths".methods."methods".method
The name of the HTTP method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__METHOD
|
string |
required |
quarkus.keycloak.policy-enforcer.paths."paths".methods."methods".scopes
An array of strings with the scopes associated with the method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES
|
list of string |
required |
quarkus.keycloak.policy-enforcer.paths."paths".methods."methods".scopes-enforcement-mode
A string referencing the enforcement mode for the scopes associated with a method
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES_ENFORCEMENT_MODE
|
|
all
|
quarkus.keycloak.policy-enforcer.paths."paths".enforcement-mode
Specifies how policies are enforced
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__ENFORCEMENT_MODE
|
permissive , enforcing , disabled
|
enforcing
|
quarkus.keycloak.policy-enforcer.paths."paths".claim-information-point."complex-config"
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__CLAIM_INFORMATION_POINT__COMPLEX_CONFIG_
|
Map<String,Map<String,Map<String,String>>> |
|
quarkus.keycloak.policy-enforcer.paths."paths".claim-information-point."simple-config"
Environment variable: QUARKUS_KEYCLOAK_POLICY_ENFORCER_PATHS__PATHS__CLAIM_INFORMATION_POINT__SIMPLE_CONFIG_
|
Map<String,Map<String,String>> |
|
Additional named tenants |
Type |
Default |
quarkus.keycloak."tenant".connection-pool-size
Adapters will make separate HTTP invocations to the Keycloak server to turn an access code into an access token. This config option defines how many connections to the Keycloak server should be pooled
Environment variable: QUARKUS_KEYCLOAK__TENANT__CONNECTION_POOL_SIZE
|
int |
20
|
quarkus.keycloak."tenant".policy-enforcer.enforcement-mode
Specifies how policies are enforced.
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_ENFORCEMENT_MODE
|
permissive , enforcing , disabled
|
enforcing
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".name
The name of a resource on the server that is to be associated with a given path
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__NAME
|
string |
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".paths
HTTP request paths that should be protected by the policy enforcer
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__PATHS
|
list of string |
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".methods."methods".method
The name of the HTTP method
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__METHOD
|
string |
required |
quarkus.keycloak."tenant".policy-enforcer.paths."paths".methods."methods".scopes
An array of strings with the scopes associated with the method
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES
|
list of string |
required |
quarkus.keycloak."tenant".policy-enforcer.paths."paths".methods."methods".scopes-enforcement-mode
A string referencing the enforcement mode for the scopes associated with a method
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__METHODS__METHODS__SCOPES_ENFORCEMENT_MODE
|
|
all
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".enforcement-mode
Specifies how policies are enforced
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__ENFORCEMENT_MODE
|
permissive , enforcing , disabled
|
enforcing
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".claim-information-point."complex-config"
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__CLAIM_INFORMATION_POINT__COMPLEX_CONFIG_
|
Map<String,Map<String,Map<String,String>>> |
|
quarkus.keycloak."tenant".policy-enforcer.paths."paths".claim-information-point."simple-config"
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATHS__PATHS__CLAIM_INFORMATION_POINT__SIMPLE_CONFIG_
|
Map<String,Map<String,String>> |
|
quarkus.keycloak."tenant".policy-enforcer.path-cache.max-entries
Defines the limit of entries that should be kept in the cache
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATH_CACHE_MAX_ENTRIES
|
int |
1000
|
quarkus.keycloak."tenant".policy-enforcer.path-cache.lifespan
Defines the time in milliseconds when the entry should be expired
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_PATH_CACHE_LIFESPAN
|
long |
30000
|
quarkus.keycloak."tenant".policy-enforcer.lazy-load-paths
Specifies how the adapter should fetch the server for resources associated with paths in your application. If true, the policy enforcer is going to fetch resources on-demand accordingly with the path being requested
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_LAZY_LOAD_PATHS
|
boolean |
true
|
quarkus.keycloak."tenant".policy-enforcer.claim-information-point."complex-config"
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_CLAIM_INFORMATION_POINT__COMPLEX_CONFIG_
|
Map<String,Map<String,Map<String,String>>> |
|
quarkus.keycloak."tenant".policy-enforcer.claim-information-point."simple-config"
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_CLAIM_INFORMATION_POINT__SIMPLE_CONFIG_
|
Map<String,Map<String,String>> |
|
quarkus.keycloak."tenant".policy-enforcer.http-method-as-scope
Specifies how scopes should be mapped to HTTP methods. If set to true, the policy enforcer will use the HTTP method from the current request to check whether access should be granted
Environment variable: QUARKUS_KEYCLOAK__TENANT__POLICY_ENFORCER_HTTP_METHOD_AS_SCOPE
|
boolean |
false
|
Kubernetes - Vanilla |
Type |
Default |
The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use.
Environment variable: QUARKUS_OPENSHIFT_FLAVOR
|
|
v4
|
quarkus.openshift.deployment-kind
The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if flavor == v3 , or 'Deployment' otherwise. DeploymentConfig is deprecated as of OpenShift 4.14. See https://access.redhat.com/articles/7041372 for details.
Environment variable: QUARKUS_OPENSHIFT_DEPLOYMENT_KIND
|
deployment , deployment-config , stateful-set , job , cron-job , knative-service
|
|
quarkus.openshift.part-of
The name of the group this component belongs too
Environment variable: QUARKUS_OPENSHIFT_PART_OF
|
string |
|
The name of the application. This value will be used for naming Kubernetes resources like: 'Deployment', 'Service' and so on…
Environment variable: QUARKUS_OPENSHIFT_NAME
|
string |
|
quarkus.openshift.version
The version of the application.
Environment variable: QUARKUS_OPENSHIFT_VERSION
|
string |
|
quarkus.openshift.namespace
Environment variable: QUARKUS_OPENSHIFT_NAMESPACE
|
string |
|
quarkus.openshift.labels."label-name"
Custom labels to add to all resources
Environment variable: QUARKUS_OPENSHIFT_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.annotations."annotation-name"
Custom annotations to add to all resources
Environment variable: QUARKUS_OPENSHIFT_ANNOTATIONS__ANNOTATION_NAME_
|
Map<String,String> |
|
quarkus.openshift.add-build-timestamp
Add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources
Environment variable: QUARKUS_OPENSHIFT_ADD_BUILD_TIMESTAMP
|
boolean |
true
|
quarkus.openshift.working-dir
Environment variable: QUARKUS_OPENSHIFT_WORKING_DIR
|
string |
|
quarkus.openshift.command
Environment variable: QUARKUS_OPENSHIFT_COMMAND
|
list of string |
|
quarkus.openshift.arguments
Environment variable: QUARKUS_OPENSHIFT_ARGUMENTS
|
list of string |
|
quarkus.openshift.service-account
Environment variable: QUARKUS_OPENSHIFT_SERVICE_ACCOUNT
|
string |
|
quarkus.openshift.ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.openshift.ports."ports".host-port
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.openshift.ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__PATH
|
string |
/
|
quarkus.openshift.ports."ports".protocol
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.openshift.ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.openshift.ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_OPENSHIFT_PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.openshift.replicas
The number of desired pods
Environment variable: QUARKUS_OPENSHIFT_REPLICAS
|
int |
1
|
quarkus.openshift.service-type
The type of service that will be generated for the application
Environment variable: QUARKUS_OPENSHIFT_SERVICE_TYPE
|
cluster-ip , node-port , load-balancer , external-name
|
cluster-ip
|
quarkus.openshift.node-port
The nodePort to set when serviceType is set to nodePort
Environment variable: QUARKUS_OPENSHIFT_NODE_PORT
|
int |
|
quarkus.openshift.image-pull-policy
Environment variable: QUARKUS_OPENSHIFT_IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.openshift.image-pull-secrets
Environment variable: QUARKUS_OPENSHIFT_IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.openshift.generate-image-pull-secret
Enable generation of image pull secret, when the container image username and password are provided.
Environment variable: QUARKUS_OPENSHIFT_GENERATE_IMAGE_PULL_SECRET
|
boolean |
false
|
quarkus.openshift.liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.startup-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.startup-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.startup-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.startup-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.startup-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.startup-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.startup-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.startup-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.startup-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.startup-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.startup-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.startup-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.startup-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_STARTUP_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.prometheus.annotations
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_ANNOTATIONS
|
boolean |
true
|
quarkus.openshift.prometheus.generate-service-monitor
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_GENERATE_SERVICE_MONITOR
|
boolean |
true
|
quarkus.openshift.prometheus.prefix
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PREFIX
|
string |
prometheus.io
|
quarkus.openshift.prometheus.scrape
Define the annotation used to indicate services that should be scraped. By default, /scrape will be appended to the defined prefix.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_SCRAPE
|
string |
|
quarkus.openshift.prometheus.path
Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PATH
|
string |
|
quarkus.openshift.prometheus.port
Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_PORT
|
string |
|
quarkus.openshift.prometheus.scheme
Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.
Environment variable: QUARKUS_OPENSHIFT_PROMETHEUS_SCHEME
|
string |
|
quarkus.openshift.mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.openshift.mounts."mounts".path
Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.openshift.mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.openshift.mounts."mounts".read-only
Environment variable: QUARKUS_OPENSHIFT_MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.openshift.secret-volumes."secret-volumes".secret-name
The name of the secret to mount.
Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.openshift.secret-volumes."secret-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.openshift.secret-volumes."secret-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.openshift.secret-volumes."secret-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.openshift.secret-volumes."secret-volumes".optional
Environment variable: QUARKUS_OPENSHIFT_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.openshift.config-map-volumes."config-map-volumes".config-map-name
The name of the ConfigMap to mount.
Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME
|
string |
required |
quarkus.openshift.config-map-volumes."config-map-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.openshift.config-map-volumes."config-map-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.openshift.config-map-volumes."config-map-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.openshift.config-map-volumes."config-map-volumes".optional
Environment variable: QUARKUS_OPENSHIFT_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.openshift.empty-dir-volumes
Environment variable: QUARKUS_OPENSHIFT_EMPTY_DIR_VOLUMES
|
list of string |
|
quarkus.openshift.git-repo-volumes."git-repo-volumes".repository
Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY
|
string |
required |
quarkus.openshift.git-repo-volumes."git-repo-volumes".directory
The directory of the repository to mount.
Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY
|
string |
|
quarkus.openshift.git-repo-volumes."git-repo-volumes".revision
Environment variable: QUARKUS_OPENSHIFT_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION
|
string |
|
quarkus.openshift.pvc-volumes."pvc-volumes".claim-name
The name of the claim to mount.
Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME
|
string |
required |
quarkus.openshift.pvc-volumes."pvc-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.openshift.pvc-volumes."pvc-volumes".optional
Environment variable: QUARKUS_OPENSHIFT_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id
The name of the disk to mount.
Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID
|
string |
required |
quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition
Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION
|
int |
|
quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type
Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.openshift.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_OPENSHIFT_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.openshift.azure-file-volumes."azure-file-volumes".share-name
Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME
|
string |
required |
quarkus.openshift.azure-file-volumes."azure-file-volumes".secret-name
Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.openshift.azure-file-volumes."azure-file-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_OPENSHIFT_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-name
The name of the disk to mount.
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME
|
string |
required |
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".disk-uri
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI
|
string |
required |
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".kind
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND
|
|
managed
|
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".caching-mode
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE
|
read-write , read-only , none
|
read-write
|
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".fs-type
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.openshift.azure-disk-volumes."azure-disk-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_OPENSHIFT_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.openshift.init-containers."init-containers".image
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE
|
string |
|
quarkus.openshift.init-containers."init-containers".working-dir
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR
|
string |
|
quarkus.openshift.init-containers."init-containers".command
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND
|
list of string |
|
quarkus.openshift.init-containers."init-containers".arguments
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS
|
list of string |
|
quarkus.openshift.init-containers."init-containers".service-account
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT
|
string |
|
quarkus.openshift.init-containers."init-containers".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__HOST
|
string |
|
quarkus.openshift.init-containers."init-containers".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.openshift.init-containers."init-containers".ports."ports".host-port
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.openshift.init-containers."init-containers".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.openshift.init-containers."init-containers".ports."ports".protocol
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.openshift.init-containers."init-containers".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.openshift.init-containers."init-containers".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.openshift.init-containers."init-containers".image-pull-policy
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.openshift.init-containers."init-containers".image-pull-secrets
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.init-containers."init-containers".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.init-containers."init-containers".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.init-containers."init-containers".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.init-containers."init-containers".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.init-containers."init-containers".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.init-containers."init-containers".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.init-containers."init-containers".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.init-containers."init-containers".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.init-containers."init-containers".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.init-containers."init-containers".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.init-containers."init-containers".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.init-containers."init-containers".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.openshift.init-containers."init-containers".mounts."mounts".path
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.openshift.init-containers."init-containers".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.openshift.init-containers."init-containers".mounts."mounts".read-only
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.openshift.init-containers."init-containers".resources.limits.cpu
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.openshift.init-containers."init-containers".resources.limits.memory
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.openshift.init-containers."init-containers".resources.requests.cpu
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.openshift.init-containers."init-containers".resources.requests.memory
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.openshift.init-containers."init-containers".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS
|
list of string |
|
quarkus.openshift.init-containers."init-containers".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.openshift.init-containers."init-containers".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.openshift.init-containers."init-containers".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.openshift.init-containers."init-containers".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.openshift.init-containers."init-containers".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.openshift.init-containers."init-containers".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.openshift.sidecars."sidecars".image
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE
|
string |
|
quarkus.openshift.sidecars."sidecars".working-dir
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__WORKING_DIR
|
string |
|
quarkus.openshift.sidecars."sidecars".command
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__COMMAND
|
list of string |
|
quarkus.openshift.sidecars."sidecars".arguments
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ARGUMENTS
|
list of string |
|
quarkus.openshift.sidecars."sidecars".service-account
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__SERVICE_ACCOUNT
|
string |
|
quarkus.openshift.sidecars."sidecars".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__HOST
|
string |
|
quarkus.openshift.sidecars."sidecars".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.openshift.sidecars."sidecars".ports."ports".host-port
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.openshift.sidecars."sidecars".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.openshift.sidecars."sidecars".ports."ports".protocol
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.openshift.sidecars."sidecars".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.openshift.sidecars."sidecars".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.openshift.sidecars."sidecars".image-pull-policy
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.openshift.sidecars."sidecars".image-pull-secrets
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.sidecars."sidecars".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.sidecars."sidecars".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.sidecars."sidecars".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.sidecars."sidecars".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.sidecars."sidecars".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.openshift.sidecars."sidecars".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.openshift.sidecars."sidecars".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.openshift.sidecars."sidecars".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.openshift.sidecars."sidecars".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.openshift.sidecars."sidecars".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.openshift.sidecars."sidecars".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.openshift.sidecars."sidecars".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.openshift.sidecars."sidecars".mounts."mounts".path
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.openshift.sidecars."sidecars".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.openshift.sidecars."sidecars".mounts."mounts".read-only
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.openshift.sidecars."sidecars".resources.limits.cpu
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.openshift.sidecars."sidecars".resources.limits.memory
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.openshift.sidecars."sidecars".resources.requests.cpu
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.openshift.sidecars."sidecars".resources.requests.memory
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.openshift.sidecars."sidecars".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_SECRETS
|
list of string |
|
quarkus.openshift.sidecars."sidecars".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.openshift.sidecars."sidecars".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.openshift.sidecars."sidecars".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.openshift.sidecars."sidecars".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.openshift.sidecars."sidecars".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.openshift.sidecars."sidecars".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.openshift.host-aliases."host-aliases".ip
Environment variable: QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__IP
|
string |
|
quarkus.openshift.host-aliases."host-aliases".hostnames
The hostnames to resolve to the ip
Environment variable: QUARKUS_OPENSHIFT_HOST_ALIASES__HOST_ALIASES__HOSTNAMES
|
list of string |
|
quarkus.openshift.resources.limits.cpu
Environment variable: QUARKUS_OPENSHIFT_RESOURCES_LIMITS_CPU
|
string |
|
quarkus.openshift.resources.limits.memory
Environment variable: QUARKUS_OPENSHIFT_RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.openshift.resources.requests.cpu
Environment variable: QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.openshift.resources.requests.memory
Environment variable: QUARKUS_OPENSHIFT_RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.openshift.container-name
If set, it will change the name of the container according to the configuration
Environment variable: QUARKUS_OPENSHIFT_CONTAINER_NAME
|
string |
|
quarkus.openshift.route.expose
If true, the service will be exposed
Environment variable: QUARKUS_OPENSHIFT_ROUTE_EXPOSE
|
boolean |
false
|
quarkus.openshift.route.host
The host under which the application is going to be exposed
Environment variable: QUARKUS_OPENSHIFT_ROUTE_HOST
|
string |
|
quarkus.openshift.route.target-port
The target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https".
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TARGET_PORT
|
string |
http
|
quarkus.openshift.route.annotations."annotation-name"
Custom annotations to add to exposition (route or ingress) resources
Environment variable: QUARKUS_OPENSHIFT_ROUTE_ANNOTATIONS__ANNOTATION_NAME_
|
Map<String,String> |
|
quarkus.openshift.route.labels."label-name"
Custom labels to add to exposition (route or ingress) resources
Environment variable: QUARKUS_OPENSHIFT_ROUTE_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.route.tls.ca-certificate
The cert authority certificate contents.
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_CA_CERTIFICATE
|
string |
|
quarkus.openshift.route.tls.certificate
The certificate contents.
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_CERTIFICATE
|
string |
|
quarkus.openshift.route.tls.destination-ca-certificate
The contents of the ca certificate of the final destination.
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_DESTINATION_CA_CERTIFICATE
|
string |
|
quarkus.openshift.route.tls.insecure-edge-termination-policy
The desired behavior for insecure connections to a route.
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_INSECURE_EDGE_TERMINATION_POLICY
|
string |
|
quarkus.openshift.route.tls.key
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_KEY
|
string |
|
quarkus.openshift.route.tls.termination
Environment variable: QUARKUS_OPENSHIFT_ROUTE_TLS_TERMINATION
|
string |
|
quarkus.openshift.add-version-to-label-selectors
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig
Environment variable: QUARKUS_OPENSHIFT_ADD_VERSION_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.openshift.add-name-to-label-selectors
If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment
Environment variable: QUARKUS_OPENSHIFT_ADD_NAME_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.openshift.job.parallelism
Specifies the maximum desired number of pods the job should run at any given time.
Environment variable: QUARKUS_OPENSHIFT_JOB_PARALLELISM
|
int |
|
quarkus.openshift.job.completions
Specifies the desired number of successfully finished pods the job should be run with.
Environment variable: QUARKUS_OPENSHIFT_JOB_COMPLETIONS
|
int |
|
quarkus.openshift.job.completion-mode
CompletionMode specifies how Pod completions are tracked.
Environment variable: QUARKUS_OPENSHIFT_JOB_COMPLETION_MODE
|
|
non-indexed
|
quarkus.openshift.job.backoff-limit
Specifies the number of retries before marking this job failed.
Environment variable: QUARKUS_OPENSHIFT_JOB_BACKOFF_LIMIT
|
int |
|
quarkus.openshift.job.active-deadline-seconds
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.
Environment variable: QUARKUS_OPENSHIFT_JOB_ACTIVE_DEADLINE_SECONDS
|
long |
|
quarkus.openshift.job.ttl-seconds-after-finished
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.
Environment variable: QUARKUS_OPENSHIFT_JOB_TTL_SECONDS_AFTER_FINISHED
|
int |
|
quarkus.openshift.job.suspend
Suspend specifies whether the Job controller should create Pods or not.
Environment variable: QUARKUS_OPENSHIFT_JOB_SUSPEND
|
boolean |
false
|
quarkus.openshift.job.restart-policy
Restart policy when the job container fails.
Environment variable: QUARKUS_OPENSHIFT_JOB_RESTART_POLICY
|
|
on-failure
|
quarkus.openshift.cron-job.schedule
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SCHEDULE
|
string |
|
quarkus.openshift.cron-job.concurrency-policy
ConcurrencyPolicy describes how the job will be handled.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_CONCURRENCY_POLICY
|
|
allow
|
quarkus.openshift.cron-job.starting-deadline-seconds
Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_STARTING_DEADLINE_SECONDS
|
long |
|
quarkus.openshift.cron-job.failed-jobs-history-limit
The number of failed finished jobs to retain. The default value is 1.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT
|
int |
|
quarkus.openshift.cron-job.successful-jobs-history-limit
The number of successful finished jobs to retain. The default value is 3.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT
|
int |
|
quarkus.openshift.cron-job.parallelism
Specifies the maximum desired number of pods the job should run at any given time.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_PARALLELISM
|
int |
|
quarkus.openshift.cron-job.completions
Specifies the desired number of successfully finished pods the job should be run with.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_COMPLETIONS
|
int |
|
quarkus.openshift.cron-job.completion-mode
CompletionMode specifies how Pod completions are tracked.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_COMPLETION_MODE
|
|
non-indexed
|
quarkus.openshift.cron-job.backoff-limit
Specifies the number of retries before marking this job failed.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_BACKOFF_LIMIT
|
int |
|
quarkus.openshift.cron-job.active-deadline-seconds
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_ACTIVE_DEADLINE_SECONDS
|
long |
|
quarkus.openshift.cron-job.ttl-seconds-after-finished
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_TTL_SECONDS_AFTER_FINISHED
|
int |
|
quarkus.openshift.cron-job.suspend
Suspend specifies whether the Job controller should create Pods or not.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_SUSPEND
|
boolean |
false
|
quarkus.openshift.cron-job.restart-policy
Restart policy when the job container fails.
Environment variable: QUARKUS_OPENSHIFT_CRON_JOB_RESTART_POLICY
|
|
on-failure
|
quarkus.openshift.rbac.roles."roles".name
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAME
|
string |
|
quarkus.openshift.rbac.roles."roles".namespace
The namespace of the role.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__NAMESPACE
|
string |
|
quarkus.openshift.rbac.roles."roles".labels."label-name"
Labels to add into the Role resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.openshift.rbac.roles."roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".name
The name of the cluster role.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME
|
string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".labels."label-name"
Labels to add into the ClusterRole resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.openshift.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.openshift.rbac.service-accounts."service-accounts".name
The name of the service account.
Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME
|
string |
|
quarkus.openshift.rbac.service-accounts."service-accounts".namespace
The namespace of the service account.
Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE
|
string |
|
quarkus.openshift.rbac.service-accounts."service-accounts".labels."label-name"
Labels of the service account.
Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.rbac.service-accounts."service-accounts".use-as-default
If true, this service account will be used in the generated Deployment resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT
|
boolean |
|
quarkus.openshift.rbac.role-bindings."role-bindings".name
Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME
|
string |
|
quarkus.openshift.rbac.role-bindings."role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.rbac.role-bindings."role-bindings".role-name
The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it’s "view" role name.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME
|
string |
|
quarkus.openshift.rbac.role-bindings."role-bindings".cluster-wide
If the Role sets in the role-name property is cluster wide or not.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE
|
boolean |
|
quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.openshift.rbac.role-bindings."role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_OPENSHIFT_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".name
Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME
|
string |
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".role-name
The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME
|
string |
required |
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.openshift.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_OPENSHIFT_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.openshift.env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_ENV_SECRETS
|
list of string |
|
quarkus.openshift.env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_OPENSHIFT_ENV_CONFIGMAPS
|
list of string |
|
quarkus.openshift.env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_OPENSHIFT_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.openshift.env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_OPENSHIFT_ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.openshift.env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.openshift.env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.openshift.env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_OPENSHIFT_ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.openshift.env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.openshift.env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_OPENSHIFT_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.openshift.app-secret
If set, the secret will mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_OPENSHIFT_APP_SECRET
|
string |
|
quarkus.openshift.app-config-map
If set, the config amp will be mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_OPENSHIFT_APP_CONFIG_MAP
|
string |
|
quarkus.openshift.security-context.se-linux-options.level
The SELinux level label that applies to the container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL
|
string |
|
quarkus.openshift.security-context.se-linux-options.role
The SELinux role label that applies to the container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE
|
string |
|
quarkus.openshift.security-context.se-linux-options.type
The SELinux type label that applies to the container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE
|
string |
|
quarkus.openshift.security-context.se-linux-options.user
The SELinux user label that applies to the container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER
|
string |
|
quarkus.openshift.security-context.windows-options.gmsa-credential-spec-name
The name of the GMSA credential spec to use.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME
|
string |
|
quarkus.openshift.security-context.windows-options.gmsa-credential-spec
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC
|
string |
|
quarkus.openshift.security-context.windows-options.run-as-user-name
The UserName in Windows to run the entrypoint of the container process.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME
|
string |
|
quarkus.openshift.security-context.windows-options.host-process
HostProcess determines if a container should be run as a 'Host Process' container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS
|
boolean |
|
quarkus.openshift.security-context.run-as-user
The UID to run the entrypoint of the container process.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_USER
|
long |
|
quarkus.openshift.security-context.run-as-group
The GID to run the entrypoint of the container process.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_GROUP
|
long |
|
quarkus.openshift.security-context.run-as-non-root
Indicates that the container must run as a non-root user.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_RUN_AS_NON_ROOT
|
boolean |
|
quarkus.openshift.security-context.supplemental-groups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS
|
list of long |
|
quarkus.openshift.security-context.fs-group
A special supplemental group that applies to all containers in a pod.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP
|
long |
|
quarkus.openshift.security-context.sysctls."sysctl-name"
Sysctls hold a list of namespaced sysctls used for the pod.
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_
|
Map<String,String> |
|
quarkus.openshift.security-context.fs-group-change-policy
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always
Environment variable: QUARKUS_OPENSHIFT_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY
|
|
|
quarkus.openshift.remote-debug.enabled
If true, the debug mode in pods will be enabled.
Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_ENABLED
|
boolean |
false
|
quarkus.openshift.remote-debug.transport
Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_TRANSPORT
|
string |
dt_socket
|
quarkus.openshift.remote-debug.suspend
If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection.
Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_SUSPEND
|
string |
n
|
quarkus.openshift.remote-debug.address-port
It specifies the address at which the debug socket will listen.
Environment variable: QUARKUS_OPENSHIFT_REMOTE_DEBUG_ADDRESS_PORT
|
int |
5005
|
If set to true, Quarkus will attempt to deploy the application to the target Openshift cluster
Environment variable: QUARKUS_OPENSHIFT_DEPLOY
|
boolean |
false
|
quarkus.openshift.deploy-strategy
If deploy is enabled, it will follow this strategy to update the resources to the target OpenShift cluster.
Environment variable: QUARKUS_OPENSHIFT_DEPLOY_STRATEGY
|
create-or-update , create , replace , server-side-apply
|
create-or-update
|
quarkus.openshift.init-tasks."init-tasks".enabled
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.
Environment variable: QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__ENABLED
|
boolean |
true
|
quarkus.openshift.init-tasks."init-tasks".wait-for-container.image
The init task image to use by the init-container.
Environment variable: QUARKUS_OPENSHIFT_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE
|
string |
groundnuty/k8s-wait-for:no-root-v1.7
|
quarkus.openshift.init-task-defaults.enabled
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.
Environment variable: QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_ENABLED
|
boolean |
true
|
quarkus.openshift.init-task-defaults.wait-for-container.image
The init task image to use by the init-container.
Environment variable: QUARKUS_OPENSHIFT_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE
|
string |
groundnuty/k8s-wait-for:no-root-v1.7
|
quarkus.openshift.idempotent
Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility
Environment variable: QUARKUS_OPENSHIFT_IDEMPOTENT
|
boolean |
false
|
quarkus.openshift.vcs-uri.enabled
Whether the vcs-uri annotation should be added to the generated configuration.
Environment variable: QUARKUS_OPENSHIFT_VCS_URI_ENABLED
|
boolean |
true
|
quarkus.openshift.vcs-uri.override
Optional override of the vcs-uri annotation.
Environment variable: QUARKUS_OPENSHIFT_VCS_URI_OVERRIDE
|
string |
|
quarkus.kubernetes.part-of
The name of the group this component belongs too
Environment variable: QUARKUS_KUBERNETES_PART_OF
|
string |
|
The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on …
Environment variable: QUARKUS_KUBERNETES_NAME
|
string |
|
quarkus.kubernetes.version
The version of the application.
Environment variable: QUARKUS_KUBERNETES_VERSION
|
string |
|
quarkus.kubernetes.deployment-kind
The kind of the deployment resource to use. Supported values are 'StatefulSet', 'Job', 'CronJob' and 'Deployment' defaulting to the latter.
Environment variable: QUARKUS_KUBERNETES_DEPLOYMENT_KIND
|
deployment , deployment-config , stateful-set , job , cron-job , knative-service
|
|
quarkus.kubernetes.namespace
Environment variable: QUARKUS_KUBERNETES_NAMESPACE
|
string |
|
quarkus.kubernetes.labels."label-name"
Custom labels to add to all resources
Environment variable: QUARKUS_KUBERNETES_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.annotations."annotation-name"
Custom annotations to add to all resources
Environment variable: QUARKUS_KUBERNETES_ANNOTATIONS__ANNOTATION_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.add-build-timestamp
Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources
Environment variable: QUARKUS_KUBERNETES_ADD_BUILD_TIMESTAMP
|
boolean |
true
|
quarkus.kubernetes.working-dir
Environment variable: QUARKUS_KUBERNETES_WORKING_DIR
|
string |
|
quarkus.kubernetes.command
Environment variable: QUARKUS_KUBERNETES_COMMAND
|
list of string |
|
quarkus.kubernetes.arguments
Environment variable: QUARKUS_KUBERNETES_ARGUMENTS
|
list of string |
|
quarkus.kubernetes.service-account
Environment variable: QUARKUS_KUBERNETES_SERVICE_ACCOUNT
|
string |
|
quarkus.kubernetes.ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.kubernetes.ports."ports".host-port
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.kubernetes.ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__PATH
|
string |
/
|
quarkus.kubernetes.ports."ports".protocol
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.kubernetes.ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.kubernetes.ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KUBERNETES_PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.kubernetes.replicas
The number of desired pods
Environment variable: QUARKUS_KUBERNETES_REPLICAS
|
int |
1
|
quarkus.kubernetes.strategy
Specifies the deployment strategy.
Environment variable: QUARKUS_KUBERNETES_STRATEGY
|
none , recreate , rolling-update
|
none
|
quarkus.kubernetes.rolling-update.max-unavailable
Specifies the maximum number of Pods that can be unavailable during the update process.
Environment variable: QUARKUS_KUBERNETES_ROLLING_UPDATE_MAX_UNAVAILABLE
|
string |
25%
|
quarkus.kubernetes.rolling-update.max-surge
Specifies the maximum number of Pods that can be created over the desired number of Pods.
Environment variable: QUARKUS_KUBERNETES_ROLLING_UPDATE_MAX_SURGE
|
string |
25%
|
quarkus.kubernetes.service-type
The type of service that will be generated for the application
Environment variable: QUARKUS_KUBERNETES_SERVICE_TYPE
|
cluster-ip , node-port , load-balancer , external-name
|
cluster-ip
|
quarkus.kubernetes.node-port
The nodePort to set when serviceType is set to node-port.
Environment variable: QUARKUS_KUBERNETES_NODE_PORT
|
int |
|
quarkus.kubernetes.image-pull-policy
Environment variable: QUARKUS_KUBERNETES_IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.kubernetes.image-pull-secrets
Environment variable: QUARKUS_KUBERNETES_IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.kubernetes.generate-image-pull-secret
Enable generation of image pull secret, when the container image username and password are provided.
Environment variable: QUARKUS_KUBERNETES_GENERATE_IMAGE_PULL_SECRET
|
boolean |
false
|
quarkus.kubernetes.liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.startup-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.startup-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.startup-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.startup-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.startup-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.startup-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.startup-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.startup-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.startup-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.startup-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.startup-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.startup-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.startup-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_STARTUP_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.prometheus.annotations
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_ANNOTATIONS
|
boolean |
true
|
quarkus.kubernetes.prometheus.generate-service-monitor
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_GENERATE_SERVICE_MONITOR
|
boolean |
true
|
quarkus.kubernetes.prometheus.prefix
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_PREFIX
|
string |
prometheus.io
|
quarkus.kubernetes.prometheus.scrape
Define the annotation used to indicate services that should be scraped. By default, /scrape will be appended to the defined prefix.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_SCRAPE
|
string |
|
quarkus.kubernetes.prometheus.path
Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_PATH
|
string |
|
quarkus.kubernetes.prometheus.port
Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_PORT
|
string |
|
quarkus.kubernetes.prometheus.scheme
Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.
Environment variable: QUARKUS_KUBERNETES_PROMETHEUS_SCHEME
|
string |
|
quarkus.kubernetes.mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KUBERNETES_MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.kubernetes.mounts."mounts".path
Environment variable: QUARKUS_KUBERNETES_MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.kubernetes.mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KUBERNETES_MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.kubernetes.mounts."mounts".read-only
Environment variable: QUARKUS_KUBERNETES_MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.secret-volumes."secret-volumes".secret-name
The name of the secret to mount.
Environment variable: QUARKUS_KUBERNETES_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.kubernetes.secret-volumes."secret-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KUBERNETES_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.kubernetes.secret-volumes."secret-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_KUBERNETES_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.kubernetes.secret-volumes."secret-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_KUBERNETES_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.kubernetes.secret-volumes."secret-volumes".optional
Environment variable: QUARKUS_KUBERNETES_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.kubernetes.config-map-volumes."config-map-volumes".config-map-name
The name of the ConfigMap to mount.
Environment variable: QUARKUS_KUBERNETES_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME
|
string |
required |
quarkus.kubernetes.config-map-volumes."config-map-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KUBERNETES_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.kubernetes.config-map-volumes."config-map-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_KUBERNETES_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.kubernetes.config-map-volumes."config-map-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_KUBERNETES_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.kubernetes.config-map-volumes."config-map-volumes".optional
Environment variable: QUARKUS_KUBERNETES_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.kubernetes.empty-dir-volumes
Environment variable: QUARKUS_KUBERNETES_EMPTY_DIR_VOLUMES
|
list of string |
|
quarkus.kubernetes.git-repo-volumes."git-repo-volumes".repository
Environment variable: QUARKUS_KUBERNETES_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY
|
string |
required |
quarkus.kubernetes.git-repo-volumes."git-repo-volumes".directory
The directory of the repository to mount.
Environment variable: QUARKUS_KUBERNETES_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY
|
string |
|
quarkus.kubernetes.git-repo-volumes."git-repo-volumes".revision
Environment variable: QUARKUS_KUBERNETES_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION
|
string |
|
quarkus.kubernetes.pvc-volumes."pvc-volumes".claim-name
The name of the claim to mount.
Environment variable: QUARKUS_KUBERNETES_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME
|
string |
required |
quarkus.kubernetes.pvc-volumes."pvc-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KUBERNETES_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.kubernetes.pvc-volumes."pvc-volumes".optional
Environment variable: QUARKUS_KUBERNETES_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.kubernetes.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id
The name of the disk to mount.
Environment variable: QUARKUS_KUBERNETES_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID
|
string |
required |
quarkus.kubernetes.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition
Environment variable: QUARKUS_KUBERNETES_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION
|
int |
|
quarkus.kubernetes.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type
Environment variable: QUARKUS_KUBERNETES_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.kubernetes.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KUBERNETES_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.azure-file-volumes."azure-file-volumes".share-name
Environment variable: QUARKUS_KUBERNETES_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME
|
string |
required |
quarkus.kubernetes.azure-file-volumes."azure-file-volumes".secret-name
Environment variable: QUARKUS_KUBERNETES_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.kubernetes.azure-file-volumes."azure-file-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KUBERNETES_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".disk-name
The name of the disk to mount.
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME
|
string |
required |
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".disk-uri
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI
|
string |
required |
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".kind
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND
|
|
managed
|
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".caching-mode
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE
|
read-write , read-only , none
|
read-write
|
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".fs-type
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.kubernetes.azure-disk-volumes."azure-disk-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KUBERNETES_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.init-containers."init-containers".image
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE
|
string |
|
quarkus.kubernetes.init-containers."init-containers".working-dir
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR
|
string |
|
quarkus.kubernetes.init-containers."init-containers".command
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND
|
list of string |
|
quarkus.kubernetes.init-containers."init-containers".arguments
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS
|
list of string |
|
quarkus.kubernetes.init-containers."init-containers".service-account
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT
|
string |
|
quarkus.kubernetes.init-containers."init-containers".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__HOST
|
string |
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".host-port
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".protocol
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.kubernetes.init-containers."init-containers".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.kubernetes.init-containers."init-containers".image-pull-policy
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.kubernetes.init-containers."init-containers".image-pull-secrets
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.init-containers."init-containers".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.init-containers."init-containers".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.init-containers."init-containers".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.kubernetes.init-containers."init-containers".mounts."mounts".path
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.kubernetes.init-containers."init-containers".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.kubernetes.init-containers."init-containers".mounts."mounts".read-only
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.init-containers."init-containers".resources.limits.cpu
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.kubernetes.init-containers."init-containers".resources.limits.memory
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.kubernetes.init-containers."init-containers".resources.requests.cpu
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.kubernetes.init-containers."init-containers".resources.requests.memory
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.kubernetes.init-containers."init-containers".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS
|
list of string |
|
quarkus.kubernetes.init-containers."init-containers".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.kubernetes.init-containers."init-containers".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.init-containers."init-containers".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.kubernetes.init-containers."init-containers".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.kubernetes.init-containers."init-containers".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.kubernetes.init-containers."init-containers".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.kubernetes.init-containers."init-containers".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.kubernetes.init-containers."init-containers".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.kubernetes.sidecars."sidecars".image
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__IMAGE
|
string |
|
quarkus.kubernetes.sidecars."sidecars".working-dir
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__WORKING_DIR
|
string |
|
quarkus.kubernetes.sidecars."sidecars".command
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__COMMAND
|
list of string |
|
quarkus.kubernetes.sidecars."sidecars".arguments
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ARGUMENTS
|
list of string |
|
quarkus.kubernetes.sidecars."sidecars".service-account
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__SERVICE_ACCOUNT
|
string |
|
quarkus.kubernetes.sidecars."sidecars".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__HOST
|
string |
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".host-port
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".protocol
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.kubernetes.sidecars."sidecars".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.kubernetes.sidecars."sidecars".image-pull-policy
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.kubernetes.sidecars."sidecars".image-pull-secrets
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.sidecars."sidecars".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.kubernetes.sidecars."sidecars".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.kubernetes.sidecars."sidecars".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.kubernetes.sidecars."sidecars".mounts."mounts".path
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.kubernetes.sidecars."sidecars".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.kubernetes.sidecars."sidecars".mounts."mounts".read-only
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.kubernetes.sidecars."sidecars".resources.limits.cpu
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.kubernetes.sidecars."sidecars".resources.limits.memory
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.kubernetes.sidecars."sidecars".resources.requests.cpu
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.kubernetes.sidecars."sidecars".resources.requests.memory
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.kubernetes.sidecars."sidecars".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_SECRETS
|
list of string |
|
quarkus.kubernetes.sidecars."sidecars".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.kubernetes.sidecars."sidecars".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.sidecars."sidecars".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.kubernetes.sidecars."sidecars".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.kubernetes.sidecars."sidecars".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.kubernetes.sidecars."sidecars".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.kubernetes.sidecars."sidecars".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.kubernetes.sidecars."sidecars".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_SIDECARS__SIDECARS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.kubernetes.deployment-target
The target deployment platform. Defaults to kubernetes. Can be kubernetes, openshift, knative, minikube etc., or any combination of the above as comma separated list.
Environment variable: QUARKUS_KUBERNETES_DEPLOYMENT_TARGET
|
list of string |
|
quarkus.kubernetes.hostaliases."host-aliases".ip
Environment variable: QUARKUS_KUBERNETES_HOSTALIASES__HOST_ALIASES__IP
|
string |
|
quarkus.kubernetes.hostaliases."host-aliases".hostnames
The hostnames to resolve to the ip
Environment variable: QUARKUS_KUBERNETES_HOSTALIASES__HOST_ALIASES__HOSTNAMES
|
list of string |
|
quarkus.kubernetes.resources.limits.cpu
Environment variable: QUARKUS_KUBERNETES_RESOURCES_LIMITS_CPU
|
string |
|
quarkus.kubernetes.resources.limits.memory
Environment variable: QUARKUS_KUBERNETES_RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.kubernetes.resources.requests.cpu
Environment variable: QUARKUS_KUBERNETES_RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.kubernetes.resources.requests.memory
Environment variable: QUARKUS_KUBERNETES_RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.kubernetes.rbac.roles."roles".name
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__NAME
|
string |
|
quarkus.kubernetes.rbac.roles."roles".namespace
The namespace of the role.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__NAMESPACE
|
string |
|
quarkus.kubernetes.rbac.roles."roles".labels."label-name"
Labels to add into the Role resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.rbac.roles."roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.kubernetes.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.kubernetes.rbac.roles."roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.kubernetes.rbac.roles."roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.kubernetes.rbac.roles."roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".name
The name of the cluster role.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME
|
string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".labels."label-name"
Labels to add into the ClusterRole resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.kubernetes.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.kubernetes.rbac.service-accounts."service-accounts".name
The name of the service account.
Environment variable: QUARKUS_KUBERNETES_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME
|
string |
|
quarkus.kubernetes.rbac.service-accounts."service-accounts".namespace
The namespace of the service account.
Environment variable: QUARKUS_KUBERNETES_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE
|
string |
|
quarkus.kubernetes.rbac.service-accounts."service-accounts".labels."label-name"
Labels of the service account.
Environment variable: QUARKUS_KUBERNETES_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.rbac.service-accounts."service-accounts".use-as-default
If true, this service account will be used in the generated Deployment resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT
|
boolean |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".name
Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME
|
string |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".role-name
The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it’s "view" role name.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME
|
string |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".cluster-wide
If the Role sets in the role-name property is cluster wide or not.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE
|
boolean |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.kubernetes.rbac.role-bindings."role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_KUBERNETES_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".name
Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME
|
string |
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".role-name
The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME
|
string |
required |
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.kubernetes.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_KUBERNETES_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.kubernetes.ingress.expose
If true, the service will be exposed
Environment variable: QUARKUS_KUBERNETES_INGRESS_EXPOSE
|
boolean |
false
|
quarkus.kubernetes.ingress.host
The host under which the application is going to be exposed
Environment variable: QUARKUS_KUBERNETES_INGRESS_HOST
|
string |
|
quarkus.kubernetes.ingress.target-port
The default target named port. If not provided, it will be deducted from the Service resource ports. Options are: "http" and "https".
Environment variable: QUARKUS_KUBERNETES_INGRESS_TARGET_PORT
|
string |
http
|
quarkus.kubernetes.ingress.ingress-class-name
The class of the Ingress. If the ingressClassName is omitted, a default Ingress class is used.
Environment variable: QUARKUS_KUBERNETES_INGRESS_INGRESS_CLASS_NAME
|
string |
|
quarkus.kubernetes.ingress.annotations."annotation-name"
Custom annotations to add to exposition (route or ingress) resources
Environment variable: QUARKUS_KUBERNETES_INGRESS_ANNOTATIONS__ANNOTATION_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.ingress.tls."tls".enabled
If true, it will use the TLS configuration in the generated Ingress resource.
Environment variable: QUARKUS_KUBERNETES_INGRESS_TLS__TLS__ENABLED
|
boolean |
false
|
quarkus.kubernetes.ingress.tls."tls".hosts
The list of hosts to be included in the TLS certificate. By default, it will use the application host.
Environment variable: QUARKUS_KUBERNETES_INGRESS_TLS__TLS__HOSTS
|
list of string |
|
quarkus.kubernetes.ingress.rules."rules".host
The host under which the rule is going to be used.
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__HOST
|
string |
required |
quarkus.kubernetes.ingress.rules."rules".path
The path under which the rule is going to be used. Default is "/".
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__PATH
|
string |
/
|
quarkus.kubernetes.ingress.rules."rules".path-type
The path type strategy to use by the Ingress rule. Default is "Prefix".
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__PATH_TYPE
|
string |
Prefix
|
quarkus.kubernetes.ingress.rules."rules".service-name
The service name to be used by this Ingress rule. Default is the generated service name of the application.
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__SERVICE_NAME
|
string |
|
quarkus.kubernetes.ingress.rules."rules".service-port-name
The service port name to be used by this Ingress rule. Default is the port name of the generated service of the application.
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__SERVICE_PORT_NAME
|
string |
|
quarkus.kubernetes.ingress.rules."rules".service-port-number
The service port number to be used by this Ingress rule. This is only used when the servicePortName is not set.
Environment variable: QUARKUS_KUBERNETES_INGRESS_RULES__RULES__SERVICE_PORT_NUMBER
|
int |
|
quarkus.kubernetes.job.parallelism
Specifies the maximum desired number of pods the job should run at any given time.
Environment variable: QUARKUS_KUBERNETES_JOB_PARALLELISM
|
int |
|
quarkus.kubernetes.job.completions
Specifies the desired number of successfully finished pods the job should be run with.
Environment variable: QUARKUS_KUBERNETES_JOB_COMPLETIONS
|
int |
|
quarkus.kubernetes.job.completion-mode
CompletionMode specifies how Pod completions are tracked.
Environment variable: QUARKUS_KUBERNETES_JOB_COMPLETION_MODE
|
|
non-indexed
|
quarkus.kubernetes.job.backoff-limit
Specifies the number of retries before marking this job failed.
Environment variable: QUARKUS_KUBERNETES_JOB_BACKOFF_LIMIT
|
int |
|
quarkus.kubernetes.job.active-deadline-seconds
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.
Environment variable: QUARKUS_KUBERNETES_JOB_ACTIVE_DEADLINE_SECONDS
|
long |
|
quarkus.kubernetes.job.ttl-seconds-after-finished
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.
Environment variable: QUARKUS_KUBERNETES_JOB_TTL_SECONDS_AFTER_FINISHED
|
int |
|
quarkus.kubernetes.job.suspend
Suspend specifies whether the Job controller should create Pods or not.
Environment variable: QUARKUS_KUBERNETES_JOB_SUSPEND
|
boolean |
false
|
quarkus.kubernetes.job.restart-policy
Restart policy when the job container fails.
Environment variable: QUARKUS_KUBERNETES_JOB_RESTART_POLICY
|
|
on-failure
|
quarkus.kubernetes.cron-job.schedule
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_SCHEDULE
|
string |
|
quarkus.kubernetes.cron-job.concurrency-policy
ConcurrencyPolicy describes how the job will be handled.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_CONCURRENCY_POLICY
|
|
allow
|
quarkus.kubernetes.cron-job.starting-deadline-seconds
Deadline in seconds for starting the job if it misses scheduled time for any reason. Missed jobs executions will be counted as failed ones.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_STARTING_DEADLINE_SECONDS
|
long |
|
quarkus.kubernetes.cron-job.failed-jobs-history-limit
The number of failed finished jobs to retain. The default value is 1.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_FAILED_JOBS_HISTORY_LIMIT
|
int |
|
quarkus.kubernetes.cron-job.successful-jobs-history-limit
The number of successful finished jobs to retain. The default value is 3.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_SUCCESSFUL_JOBS_HISTORY_LIMIT
|
int |
|
quarkus.kubernetes.cron-job.parallelism
Specifies the maximum desired number of pods the job should run at any given time.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_PARALLELISM
|
int |
|
quarkus.kubernetes.cron-job.completions
Specifies the desired number of successfully finished pods the job should be run with.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_COMPLETIONS
|
int |
|
quarkus.kubernetes.cron-job.completion-mode
CompletionMode specifies how Pod completions are tracked.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_COMPLETION_MODE
|
|
non-indexed
|
quarkus.kubernetes.cron-job.backoff-limit
Specifies the number of retries before marking this job failed.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_BACKOFF_LIMIT
|
int |
|
quarkus.kubernetes.cron-job.active-deadline-seconds
Specifies the duration in seconds relative to the startTime that the job may be continuously active before the system tries to terminate it; value must be positive integer.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_ACTIVE_DEADLINE_SECONDS
|
long |
|
quarkus.kubernetes.cron-job.ttl-seconds-after-finished
Limits the lifetime of a Job that has finished execution (either Complete or Failed). If this field is set, ttlSecondsAfterFinished after the Job finishes, it is eligible to be automatically deleted.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_TTL_SECONDS_AFTER_FINISHED
|
int |
|
quarkus.kubernetes.cron-job.suspend
Suspend specifies whether the Job controller should create Pods or not.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_SUSPEND
|
boolean |
false
|
quarkus.kubernetes.cron-job.restart-policy
Restart policy when the job container fails.
Environment variable: QUARKUS_KUBERNETES_CRON_JOB_RESTART_POLICY
|
|
on-failure
|
quarkus.kubernetes.add-version-to-label-selectors
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment
Environment variable: QUARKUS_KUBERNETES_ADD_VERSION_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.kubernetes.add-name-to-label-selectors
If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment
Environment variable: QUARKUS_KUBERNETES_ADD_NAME_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.kubernetes.deploy
If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster
Environment variable: QUARKUS_KUBERNETES_DEPLOY
|
boolean |
false
|
quarkus.kubernetes.deploy-strategy
If deploy is enabled, it will follow this strategy to update the resources to the target Kubernetes cluster.
Environment variable: QUARKUS_KUBERNETES_DEPLOY_STRATEGY
|
create-or-update , create , replace , server-side-apply
|
create-or-update
|
quarkus.kubernetes.app-secret
If set, the secret will mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_KUBERNETES_APP_SECRET
|
string |
|
quarkus.kubernetes.app-config-map
If set, the config map will be mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_KUBERNETES_APP_CONFIG_MAP
|
string |
|
quarkus.kubernetes.security-context.se-linux-options.level
The SELinux level label that applies to the container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL
|
string |
|
quarkus.kubernetes.security-context.se-linux-options.role
The SELinux role label that applies to the container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE
|
string |
|
quarkus.kubernetes.security-context.se-linux-options.type
The SELinux type label that applies to the container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE
|
string |
|
quarkus.kubernetes.security-context.se-linux-options.user
The SELinux user label that applies to the container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER
|
string |
|
quarkus.kubernetes.security-context.windows-options.gmsa-credential-spec-name
The name of the GMSA credential spec to use.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME
|
string |
|
quarkus.kubernetes.security-context.windows-options.gmsa-credential-spec
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC
|
string |
|
quarkus.kubernetes.security-context.windows-options.run-as-user-name
The UserName in Windows to run the entrypoint of the container process.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME
|
string |
|
quarkus.kubernetes.security-context.windows-options.host-process
HostProcess determines if a container should be run as a 'Host Process' container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS
|
boolean |
|
quarkus.kubernetes.security-context.run-as-user
The UID to run the entrypoint of the container process.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_RUN_AS_USER
|
long |
|
quarkus.kubernetes.security-context.run-as-group
The GID to run the entrypoint of the container process.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_RUN_AS_GROUP
|
long |
|
quarkus.kubernetes.security-context.run-as-non-root
Indicates that the container must run as a non-root user.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_RUN_AS_NON_ROOT
|
boolean |
|
quarkus.kubernetes.security-context.supplemental-groups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS
|
list of long |
|
quarkus.kubernetes.security-context.fs-group
A special supplemental group that applies to all containers in a pod.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_FS_GROUP
|
long |
|
quarkus.kubernetes.security-context.sysctls."sysctl-name"
Sysctls hold a list of namespaced sysctls used for the pod.
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.security-context.fs-group-change-policy
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always
Environment variable: QUARKUS_KUBERNETES_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY
|
|
|
quarkus.kubernetes.container-name
If set, it will change the name of the container according to the configuration
Environment variable: QUARKUS_KUBERNETES_CONTAINER_NAME
|
string |
|
quarkus.kubernetes.remote-debug.enabled
If true, the debug mode in pods will be enabled.
Environment variable: QUARKUS_KUBERNETES_REMOTE_DEBUG_ENABLED
|
boolean |
false
|
quarkus.kubernetes.remote-debug.transport
Environment variable: QUARKUS_KUBERNETES_REMOTE_DEBUG_TRANSPORT
|
string |
dt_socket
|
quarkus.kubernetes.remote-debug.suspend
If enabled, it means the JVM will wait for the debugger to attach before executing the main class. If false, the JVM will immediately execute the main class, while listening for the debugger connection.
Environment variable: QUARKUS_KUBERNETES_REMOTE_DEBUG_SUSPEND
|
string |
n
|
quarkus.kubernetes.remote-debug.address-port
It specifies the address at which the debug socket will listen.
Environment variable: QUARKUS_KUBERNETES_REMOTE_DEBUG_ADDRESS_PORT
|
int |
5005
|
quarkus.kubernetes.init-tasks."init-tasks".enabled
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.
Environment variable: QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__ENABLED
|
boolean |
true
|
quarkus.kubernetes.init-tasks."init-tasks".wait-for-container.image
The init task image to use by the init-container.
Environment variable: QUARKUS_KUBERNETES_INIT_TASKS__INIT_TASKS__WAIT_FOR_CONTAINER_IMAGE
|
string |
groundnuty/k8s-wait-for:no-root-v1.7
|
quarkus.kubernetes.init-task-defaults.enabled
If true, the init task will be generated. Otherwise, the init task resource generation will be skipped.
Environment variable: QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_ENABLED
|
boolean |
true
|
quarkus.kubernetes.init-task-defaults.wait-for-container.image
The init task image to use by the init-container.
Environment variable: QUARKUS_KUBERNETES_INIT_TASK_DEFAULTS_WAIT_FOR_CONTAINER_IMAGE
|
string |
groundnuty/k8s-wait-for:no-root-v1.7
|
quarkus.kubernetes.idempotent
Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility
Environment variable: QUARKUS_KUBERNETES_IDEMPOTENT
|
boolean |
false
|
quarkus.kubernetes.vcs-uri.enabled
Whether the vcs-uri annotation should be added to the generated configuration.
Environment variable: QUARKUS_KUBERNETES_VCS_URI_ENABLED
|
boolean |
true
|
quarkus.kubernetes.vcs-uri.override
Optional override of the vcs-uri annotation.
Environment variable: QUARKUS_KUBERNETES_VCS_URI_OVERRIDE
|
string |
|
quarkus.kubernetes.output-directory
Optionally set directory generated kubernetes resources will be written to. Default is target/kubernetes .
Environment variable: QUARKUS_KUBERNETES_OUTPUT_DIRECTORY
|
string |
|
quarkus.kubernetes.env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_ENV_SECRETS
|
list of string |
|
quarkus.kubernetes.env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KUBERNETES_ENV_CONFIGMAPS
|
list of string |
|
quarkus.kubernetes.env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KUBERNETES_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.kubernetes.env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KUBERNETES_ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.kubernetes.env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KUBERNETES_ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.kubernetes.env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KUBERNETES_ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.kubernetes.env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KUBERNETES_ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.kubernetes.env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.kubernetes.env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KUBERNETES_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
The name of the group this component belongs too
Environment variable: QUARKUS_KNATIVE_PART_OF
|
string |
|
The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on …
Environment variable: QUARKUS_KNATIVE_NAME
|
string |
|
The version of the application.
Environment variable: QUARKUS_KNATIVE_VERSION
|
string |
|
quarkus.knative.namespace
Environment variable: QUARKUS_KNATIVE_NAMESPACE
|
string |
|
quarkus.knative.labels."label-name"
Custom labels to add to all resources
Environment variable: QUARKUS_KNATIVE_LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.annotations."annotation-name"
Custom annotations to add to all resources
Environment variable: QUARKUS_KNATIVE_ANNOTATIONS__ANNOTATION_NAME_
|
Map<String,String> |
|
quarkus.knative.add-build-timestamp
Whether to add the build timestamp to the Kubernetes annotations This is a very useful way to have manifests of successive builds of the same application differ - thus ensuring that Kubernetes will apply the updated resources
Environment variable: QUARKUS_KNATIVE_ADD_BUILD_TIMESTAMP
|
boolean |
true
|
quarkus.knative.working-dir
Environment variable: QUARKUS_KNATIVE_WORKING_DIR
|
string |
|
Environment variable: QUARKUS_KNATIVE_COMMAND
|
list of string |
|
quarkus.knative.arguments
Environment variable: QUARKUS_KNATIVE_ARGUMENTS
|
list of string |
|
quarkus.knative.service-account
Environment variable: QUARKUS_KNATIVE_SERVICE_ACCOUNT
|
string |
|
quarkus.knative.ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.knative.ports."ports".host-port
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.knative.ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__PATH
|
string |
/
|
quarkus.knative.ports."ports".protocol
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.knative.ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.knative.ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KNATIVE_PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.knative.service-type
The type of service that will be generated for the application
Environment variable: QUARKUS_KNATIVE_SERVICE_TYPE
|
cluster-ip , node-port , load-balancer , external-name
|
cluster-ip
|
quarkus.knative.image-pull-policy
Environment variable: QUARKUS_KNATIVE_IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.knative.image-pull-secrets
Environment variable: QUARKUS_KNATIVE_IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.knative.generate-image-pull-secret
Enable generation of image pull secret, when the container image username and password are provided.
Environment variable: QUARKUS_KNATIVE_GENERATE_IMAGE_PULL_SECRET
|
boolean |
false
|
quarkus.knative.liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.startup-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.startup-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.startup-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.startup-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.startup-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.startup-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.startup-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.startup-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.startup-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.startup-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.startup-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.startup-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.startup-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_STARTUP_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.prometheus.annotations
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_ANNOTATIONS
|
boolean |
true
|
quarkus.knative.prometheus.generate-service-monitor
When true (the default), emit a set of annotations to identify services that should be scraped by prometheus for metrics. In configurations that use the Prometheus operator with ServiceMonitor, annotations may not be necessary.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_GENERATE_SERVICE_MONITOR
|
boolean |
true
|
quarkus.knative.prometheus.prefix
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_PREFIX
|
string |
prometheus.io
|
quarkus.knative.prometheus.scrape
Define the annotation used to indicate services that should be scraped. By default, /scrape will be appended to the defined prefix.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_SCRAPE
|
string |
|
quarkus.knative.prometheus.path
Define the annotation used to indicate the path to scrape. By default, /path will be appended to the defined prefix.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_PATH
|
string |
|
quarkus.knative.prometheus.port
Define the annotation used to indicate the port to scrape. By default, /port will be appended to the defined prefix.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_PORT
|
string |
|
quarkus.knative.prometheus.scheme
Define the annotation used to indicate the scheme to use for scraping By default, /scheme will be appended to the defined prefix.
Environment variable: QUARKUS_KNATIVE_PROMETHEUS_SCHEME
|
string |
|
quarkus.knative.mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KNATIVE_MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.knative.mounts."mounts".path
Environment variable: QUARKUS_KNATIVE_MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.knative.mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KNATIVE_MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.knative.mounts."mounts".read-only
Environment variable: QUARKUS_KNATIVE_MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.knative.secret-volumes."secret-volumes".secret-name
The name of the secret to mount.
Environment variable: QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.knative.secret-volumes."secret-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.knative.secret-volumes."secret-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.knative.secret-volumes."secret-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.knative.secret-volumes."secret-volumes".optional
Environment variable: QUARKUS_KNATIVE_SECRET_VOLUMES__SECRET_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.knative.config-map-volumes."config-map-volumes".config-map-name
The name of the ConfigMap to mount.
Environment variable: QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__CONFIG_MAP_NAME
|
string |
required |
quarkus.knative.config-map-volumes."config-map-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.knative.config-map-volumes."config-map-volumes".items."items".path
The path where the file will be mounted.
Environment variable: QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__PATH
|
string |
required |
quarkus.knative.config-map-volumes."config-map-volumes".items."items".mode
It must be a value between 0000 and 0777. If not specified, the volume defaultMode will be used.
Environment variable: QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__ITEMS__ITEMS__MODE
|
int |
-1
|
quarkus.knative.config-map-volumes."config-map-volumes".optional
Environment variable: QUARKUS_KNATIVE_CONFIG_MAP_VOLUMES__CONFIG_MAP_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.knative.empty-dir-volumes
Environment variable: QUARKUS_KNATIVE_EMPTY_DIR_VOLUMES
|
list of string |
|
quarkus.knative.git-repo-volumes."git-repo-volumes".repository
Environment variable: QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REPOSITORY
|
string |
required |
quarkus.knative.git-repo-volumes."git-repo-volumes".directory
The directory of the repository to mount.
Environment variable: QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__DIRECTORY
|
string |
|
quarkus.knative.git-repo-volumes."git-repo-volumes".revision
Environment variable: QUARKUS_KNATIVE_GIT_REPO_VOLUMES__GIT_REPO_VOLUMES__REVISION
|
string |
|
quarkus.knative.pvc-volumes."pvc-volumes".claim-name
The name of the claim to mount.
Environment variable: QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__CLAIM_NAME
|
string |
required |
quarkus.knative.pvc-volumes."pvc-volumes".default-mode
Default mode. When specifying an octal number, leading zero must be present.
Environment variable: QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__DEFAULT_MODE
|
string |
0600
|
quarkus.knative.pvc-volumes."pvc-volumes".optional
Environment variable: QUARKUS_KNATIVE_PVC_VOLUMES__PVC_VOLUMES__OPTIONAL
|
boolean |
false
|
quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".volume-id
The name of the disk to mount.
Environment variable: QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__VOLUME_ID
|
string |
required |
quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".partition
Environment variable: QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__PARTITION
|
int |
|
quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".fs-type
Environment variable: QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.knative.aws-elastic-block-store-volumes."aws-elastic-block-store-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KNATIVE_AWS_ELASTIC_BLOCK_STORE_VOLUMES__AWS_ELASTIC_BLOCK_STORE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.knative.azure-file-volumes."azure-file-volumes".share-name
Environment variable: QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SHARE_NAME
|
string |
required |
quarkus.knative.azure-file-volumes."azure-file-volumes".secret-name
Environment variable: QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__SECRET_NAME
|
string |
required |
quarkus.knative.azure-file-volumes."azure-file-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KNATIVE_AZURE_FILE_VOLUMES__AZURE_FILE_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-name
The name of the disk to mount.
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_NAME
|
string |
required |
quarkus.knative.azure-disk-volumes."azure-disk-volumes".disk-uri
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__DISK_URI
|
string |
required |
quarkus.knative.azure-disk-volumes."azure-disk-volumes".kind
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__KIND
|
|
managed
|
quarkus.knative.azure-disk-volumes."azure-disk-volumes".caching-mode
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__CACHING_MODE
|
read-write , read-only , none
|
read-write
|
quarkus.knative.azure-disk-volumes."azure-disk-volumes".fs-type
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__FS_TYPE
|
string |
ext4
|
quarkus.knative.azure-disk-volumes."azure-disk-volumes".read-only
Whether the volumeName is read only or not.
Environment variable: QUARKUS_KNATIVE_AZURE_DISK_VOLUMES__AZURE_DISK_VOLUMES__READ_ONLY
|
boolean |
false
|
quarkus.knative.container-name
If set, it will change the name of the container according to the configuration
Environment variable: QUARKUS_KNATIVE_CONTAINER_NAME
|
string |
|
quarkus.knative.init-containers."init-containers".image
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE
|
string |
|
quarkus.knative.init-containers."init-containers".working-dir
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__WORKING_DIR
|
string |
|
quarkus.knative.init-containers."init-containers".command
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__COMMAND
|
list of string |
|
quarkus.knative.init-containers."init-containers".arguments
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ARGUMENTS
|
list of string |
|
quarkus.knative.init-containers."init-containers".service-account
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__SERVICE_ACCOUNT
|
string |
|
quarkus.knative.init-containers."init-containers".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__HOST
|
string |
|
quarkus.knative.init-containers."init-containers".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.knative.init-containers."init-containers".ports."ports".host-port
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.knative.init-containers."init-containers".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.knative.init-containers."init-containers".ports."ports".protocol
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.knative.init-containers."init-containers".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.knative.init-containers."init-containers".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.knative.init-containers."init-containers".image-pull-policy
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.knative.init-containers."init-containers".image-pull-secrets
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.init-containers."init-containers".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.init-containers."init-containers".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.init-containers."init-containers".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.init-containers."init-containers".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.init-containers."init-containers".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.init-containers."init-containers".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.init-containers."init-containers".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.init-containers."init-containers".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.init-containers."init-containers".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.init-containers."init-containers".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.init-containers."init-containers".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.init-containers."init-containers".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.init-containers."init-containers".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.init-containers."init-containers".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.knative.init-containers."init-containers".mounts."mounts".path
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.knative.init-containers."init-containers".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.knative.init-containers."init-containers".mounts."mounts".read-only
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.knative.init-containers."init-containers".resources.limits.cpu
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.knative.init-containers."init-containers".resources.limits.memory
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.knative.init-containers."init-containers".resources.requests.cpu
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.knative.init-containers."init-containers".resources.requests.memory
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.knative.init-containers."init-containers".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_SECRETS
|
list of string |
|
quarkus.knative.init-containers."init-containers".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.knative.init-containers."init-containers".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.knative.init-containers."init-containers".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.knative.init-containers."init-containers".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.knative.init-containers."init-containers".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.knative.init-containers."init-containers".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_INIT_CONTAINERS__INIT_CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.knative.containers."containers".image
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE
|
string |
|
quarkus.knative.containers."containers".working-dir
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__WORKING_DIR
|
string |
|
quarkus.knative.containers."containers".command
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__COMMAND
|
list of string |
|
quarkus.knative.containers."containers".arguments
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ARGUMENTS
|
list of string |
|
quarkus.knative.containers."containers".service-account
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__SERVICE_ACCOUNT
|
string |
|
quarkus.knative.containers."containers".host
The host under which the application is going to be exposed.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__HOST
|
string |
|
quarkus.knative.containers."containers".ports."ports".container-port
The port number. Refers to the container port.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__CONTAINER_PORT
|
int |
|
quarkus.knative.containers."containers".ports."ports".host-port
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__HOST_PORT
|
int |
|
quarkus.knative.containers."containers".ports."ports".path
The application path (refers to web application path).
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PATH
|
string |
/
|
quarkus.knative.containers."containers".ports."ports".protocol
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__PROTOCOL
|
tcp , udp , sctp , http , proxy
|
tcp
|
quarkus.knative.containers."containers".ports."ports".node-port
The nodePort to which this port should be mapped to. This only takes affect when the serviceType is set to node-port.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__NODE_PORT
|
int |
|
quarkus.knative.containers."containers".ports."ports".tls
If enabled, the port will be configured to use the schema HTTPS.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__PORTS__PORTS__TLS
|
boolean |
false
|
quarkus.knative.containers."containers".image-pull-policy
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_POLICY
|
always , if-not-present , never
|
always
|
quarkus.knative.containers."containers".image-pull-secrets
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__IMAGE_PULL_SECRETS
|
list of string |
|
quarkus.knative.containers."containers".liveness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.containers."containers".liveness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.containers."containers".liveness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.containers."containers".liveness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.containers."containers".liveness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.containers."containers".liveness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.containers."containers".liveness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.containers."containers".liveness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.containers."containers".liveness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.containers."containers".liveness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.containers."containers".liveness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.containers."containers".liveness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.containers."containers".liveness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__LIVENESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.containers."containers".readiness-probe.http-action-port
The port number to use when configuring the http get action. If not configured, the port corresponding to the httpActionPortName will be used.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT
|
int |
|
quarkus.knative.containers."containers".readiness-probe.http-action-port-name
The port name for selecting the port of the HTTP get action.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PORT_NAME
|
string |
|
quarkus.knative.containers."containers".readiness-probe.http-action-path
The http path to use for the probe. For this to work, the container port also needs to be set. Assuming the container port has been set (as per above comment), if execAction or tcpSocketAction are not set, an HTTP probe will be used automatically even if no path is set (which will result in the root path being used). If Smallrye Health is used, the path will automatically be set according to the health check path.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_PATH
|
string |
|
quarkus.knative.containers."containers".readiness-probe.http-action-scheme
The scheme of the HTTP get action. Can be either "HTTP" or "HTTPS".
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_HTTP_ACTION_SCHEME
|
string |
|
quarkus.knative.containers."containers".readiness-probe.exec-action
The command to use for the probe.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_EXEC_ACTION
|
string |
|
quarkus.knative.containers."containers".readiness-probe.tcp-socket-action
The tcp socket to use for the probe (the format is host:port).
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TCP_SOCKET_ACTION
|
string |
|
quarkus.knative.containers."containers".readiness-probe.grpc-action
The gRPC port to use for the probe (the format is either port or port:service).
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION
|
string |
|
quarkus.knative.containers."containers".readiness-probe.grpc-action-enabled
If enabled and grpc-action is not provided, it will use the generated service name and the gRPC port.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_GRPC_ACTION_ENABLED
|
boolean |
false
|
quarkus.knative.containers."containers".readiness-probe.initial-delay
The amount of time to wait before starting to probe.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_INITIAL_DELAY
|
Duration |
5S
|
quarkus.knative.containers."containers".readiness-probe.period
The period in which the action should be called.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_PERIOD
|
Duration |
10S
|
quarkus.knative.containers."containers".readiness-probe.timeout
The amount of time to wait for each action.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_TIMEOUT
|
Duration |
10S
|
quarkus.knative.containers."containers".readiness-probe.success-threshold
The success threshold to use.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_SUCCESS_THRESHOLD
|
int |
1
|
quarkus.knative.containers."containers".readiness-probe.failure-threshold
The failure threshold to use.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__READINESS_PROBE_FAILURE_THRESHOLD
|
int |
3
|
quarkus.knative.containers."containers".mounts."mounts".name
The name of the volumeName to mount.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__NAME
|
string |
|
quarkus.knative.containers."containers".mounts."mounts".path
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__PATH
|
string |
|
quarkus.knative.containers."containers".mounts."mounts".sub-path
Path within the volumeName from which the container’s volumeName should be mounted.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__SUB_PATH
|
string |
|
quarkus.knative.containers."containers".mounts."mounts".read-only
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__MOUNTS__MOUNTS__READ_ONLY
|
boolean |
false
|
quarkus.knative.containers."containers".resources.limits.cpu
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_CPU
|
string |
|
quarkus.knative.containers."containers".resources.limits.memory
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.knative.containers."containers".resources.requests.cpu
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.knative.containers."containers".resources.requests.memory
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.knative.containers."containers".env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_SECRETS
|
list of string |
|
quarkus.knative.containers."containers".env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_CONFIGMAPS
|
list of string |
|
quarkus.knative.containers."containers".env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.knative.containers."containers".env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.knative.containers."containers".env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.knative.containers."containers".env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.knative.containers."containers".env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.knative.containers."containers".env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.knative.containers."containers".env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_CONTAINERS__CONTAINERS__ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.knative.host-aliases."host-aliases".ip
Environment variable: QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__IP
|
string |
|
quarkus.knative.host-aliases."host-aliases".hostnames
The hostnames to resolve to the ip
Environment variable: QUARKUS_KNATIVE_HOST_ALIASES__HOST_ALIASES__HOSTNAMES
|
list of string |
|
quarkus.knative.resources.limits.cpu
Environment variable: QUARKUS_KNATIVE_RESOURCES_LIMITS_CPU
|
string |
|
quarkus.knative.resources.limits.memory
Environment variable: QUARKUS_KNATIVE_RESOURCES_LIMITS_MEMORY
|
string |
|
quarkus.knative.resources.requests.cpu
Environment variable: QUARKUS_KNATIVE_RESOURCES_REQUESTS_CPU
|
string |
|
quarkus.knative.resources.requests.memory
Environment variable: QUARKUS_KNATIVE_RESOURCES_REQUESTS_MEMORY
|
string |
|
quarkus.knative.rbac.roles."roles".name
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAME
|
string |
|
quarkus.knative.rbac.roles."roles".namespace
The namespace of the role.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__NAMESPACE
|
string |
|
quarkus.knative.rbac.roles."roles".labels."label-name"
Labels to add into the Role resource.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.knative.rbac.roles."roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLES__ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".name
The name of the cluster role.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__NAME
|
string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".labels."label-name"
Labels to add into the ClusterRole resource.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".api-groups
API groups of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__API_GROUPS
|
list of string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".non-resource-urls
Non resource URLs of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__NON_RESOURCE_URLS
|
list of string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resource-names
Resource names of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCE_NAMES
|
list of string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".resources
Resources of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__RESOURCES
|
list of string |
|
quarkus.knative.rbac.cluster-roles."cluster-roles".policy-rules."policy-rules".verbs
Verbs of the policy rule.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLES__CLUSTER_ROLES__POLICY_RULES__POLICY_RULES__VERBS
|
list of string |
|
quarkus.knative.rbac.service-accounts."service-accounts".name
The name of the service account.
Environment variable: QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAME
|
string |
|
quarkus.knative.rbac.service-accounts."service-accounts".namespace
The namespace of the service account.
Environment variable: QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__NAMESPACE
|
string |
|
quarkus.knative.rbac.service-accounts."service-accounts".labels."label-name"
Labels of the service account.
Environment variable: QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.rbac.service-accounts."service-accounts".use-as-default
If true, this service account will be used in the generated Deployment resource.
Environment variable: QUARKUS_KNATIVE_RBAC_SERVICE_ACCOUNTS__SERVICE_ACCOUNTS__USE_AS_DEFAULT
|
boolean |
|
quarkus.knative.rbac.role-bindings."role-bindings".name
Name of the RoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__NAME
|
string |
|
quarkus.knative.rbac.role-bindings."role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.rbac.role-bindings."role-bindings".role-name
The name of the Role resource to use by the RoleRef element in the generated Role Binding resource. By default, it’s "view" role name.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__ROLE_NAME
|
string |
|
quarkus.knative.rbac.role-bindings."role-bindings".cluster-wide
If the Role sets in the role-name property is cluster wide or not.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__CLUSTER_WIDE
|
boolean |
|
quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.knative.rbac.role-bindings."role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_KNATIVE_RBAC_ROLE_BINDINGS__ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".name
Name of the ClusterRoleBinding resource to be generated. If not provided, it will use the application name plus the role ref name.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__NAME
|
string |
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".labels."label-name"
Labels to add into the RoleBinding resource.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__LABELS__LABEL_NAME_
|
Map<String,String> |
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".role-name
The name of the ClusterRole resource to use by the RoleRef element in the generated ClusterRoleBinding resource.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__ROLE_NAME
|
string |
required |
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".name
The "name" resource to use by the Subject element in the generated Role Binding resource.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAME
|
string |
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".kind
The "kind" resource to use by the Subject element in the generated Role Binding resource. By default, it uses the "ServiceAccount" kind.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__KIND
|
string |
ServiceAccount
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".api-group
The "apiGroup" resource that matches with the "kind" property. By default, it’s empty.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__API_GROUP
|
string |
|
quarkus.knative.rbac.cluster-role-bindings."cluster-role-bindings".subjects."subjects".namespace
The "namespace" resource to use by the Subject element in the generated Role Binding resource. By default, it will use the same as provided in the generated resources.
Environment variable: QUARKUS_KNATIVE_RBAC_CLUSTER_ROLE_BINDINGS__CLUSTER_ROLE_BINDINGS__SUBJECTS__SUBJECTS__NAMESPACE
|
string |
|
quarkus.knative.add-version-to-label-selectors
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment
Environment variable: QUARKUS_KNATIVE_ADD_VERSION_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.knative.add-name-to-label-selectors
If true, the 'app.kubernetes.io/name' label will be part of the selectors of Service and Deployment
Environment variable: QUARKUS_KNATIVE_ADD_NAME_TO_LABEL_SELECTORS
|
boolean |
true
|
quarkus.knative.idempotent
Switch used to control whether non-idempotent fields are included in generated kubernetes resources to improve git-ops compatibility
Environment variable: QUARKUS_KNATIVE_IDEMPOTENT
|
boolean |
false
|
quarkus.knative.vcs-uri.enabled
Whether the vcs-uri annotation should be added to the generated configuration.
Environment variable: QUARKUS_KNATIVE_VCS_URI_ENABLED
|
boolean |
true
|
quarkus.knative.vcs-uri.override
Optional override of the vcs-uri annotation.
Environment variable: QUARKUS_KNATIVE_VCS_URI_OVERRIDE
|
string |
|
quarkus.knative.env.secrets
The optional list of Secret names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_ENV_SECRETS
|
list of string |
|
quarkus.knative.env.configmaps
The optional list of ConfigMap names to load environment variables from.
Environment variable: QUARKUS_KNATIVE_ENV_CONFIGMAPS
|
list of string |
|
quarkus.knative.env.fields."environment-variable-name"
The map associating environment variable names to their associated field references they take their value from.
Environment variable: QUARKUS_KNATIVE_ENV_FIELDS__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.knative.env.vars."vars"
The map associating environment name to its associated value.
Environment variable: QUARKUS_KNATIVE_ENV_VARS__VARS_
|
Map<String,Optional<String>> |
|
quarkus.knative.env.mapping."mapping".from-secret
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with from-configmap .
Environment variable: QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_SECRET
|
string |
|
quarkus.knative.env.mapping."mapping".from-configmap
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with from-secret .
Environment variable: QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__FROM_CONFIGMAP
|
string |
|
quarkus.knative.env.mapping."mapping".with-key
The key identifying the field from which the value is extracted.
Environment variable: QUARKUS_KNATIVE_ENV_MAPPING__MAPPING__WITH_KEY
|
string |
required |
quarkus.knative.env.using-prefix."prefixes".for-secret
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_SECRET
|
string |
|
quarkus.knative.env.using-prefix."prefixes".for-configmap
The optional prefix to use when adding the environment variable to the container.
Environment variable: QUARKUS_KNATIVE_ENV_USING_PREFIX__PREFIXES__FOR_CONFIGMAP
|
string |
|
quarkus.knative.cluster-local
Whether this service is cluster-local. Cluster local services are not exposed to the outside world. More information in this link.
Environment variable: QUARKUS_KNATIVE_CLUSTER_LOCAL
|
boolean |
false
|
quarkus.knative.min-scale
This value controls the minimum number of replicas each revision should have. Knative will attempt to never have less than this number of replicas at any point in time.
Environment variable: QUARKUS_KNATIVE_MIN_SCALE
|
int |
|
quarkus.knative.max-scale
This value controls the maximum number of replicas each revision should have. Knative will attempt to never have more than this number of replicas running, or in the process of being created, at any point in time.
Environment variable: QUARKUS_KNATIVE_MAX_SCALE
|
int |
|
quarkus.knative.scale-to-zero-enabled
The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”.
Environment variable: QUARKUS_KNATIVE_SCALE_TO_ZERO_ENABLED
|
boolean |
true
|
quarkus.knative.revision-auto-scaling.auto-scaler-class
The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa).
Environment variable: QUARKUS_KNATIVE_REVISION_AUTO_SCALING_AUTO_SCALER_CLASS
|
|
|
quarkus.knative.revision-auto-scaling.metric
The autoscaling metric to use. Possible values (concurrency, rps, cpu).
Environment variable: QUARKUS_KNATIVE_REVISION_AUTO_SCALING_METRIC
|
|
|
quarkus.knative.revision-auto-scaling.target
Environment variable: QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET
|
int |
|
quarkus.knative.revision-auto-scaling.container-concurrency
The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow into the replica.
Environment variable: QUARKUS_KNATIVE_REVISION_AUTO_SCALING_CONTAINER_CONCURRENCY
|
int |
|
quarkus.knative.revision-auto-scaling.target-utilization-percentage
This value specifies a percentage of the target to actually be targeted by the autoscaler.
Environment variable: QUARKUS_KNATIVE_REVISION_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE
|
int |
|
quarkus.knative.global-auto-scaling.auto-scaler-class
The Autoscaler class. Knative Serving comes with its own autoscaler, the KPA (Knative Pod Autoscaler) but can also be configured to use Kubernetes’ HPA (Horizontal Pod Autoscaler) or even a custom third-party autoscaler. Possible values (kpa, hpa, default: kpa).
Environment variable: QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_AUTO_SCALER_CLASS
|
|
|
quarkus.knative.global-auto-scaling.container-concurrency
The exact amount of requests allowed to the replica at a time. Its default value is “0”, which means an unlimited number of requests are allowed to flow Integer>o the replica.
Environment variable: QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_CONTAINER_CONCURRENCY
|
int |
|
quarkus.knative.global-auto-scaling.target-utilization-percentage
This value specifies a percentage of the target to actually be targeted by the autoscaler.
Environment variable: QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_TARGET_UTILIZATION_PERCENTAGE
|
int |
|
quarkus.knative.global-auto-scaling.requests-per-second
The requests per second per replica.
Environment variable: QUARKUS_KNATIVE_GLOBAL_AUTO_SCALING_REQUESTS_PER_SECOND
|
int |
|
quarkus.knative.revision-name
The name of the revision.
Environment variable: QUARKUS_KNATIVE_REVISION_NAME
|
string |
|
quarkus.knative.traffic."traffic".tag
Tag is optionally used to expose a dedicated url for referencing this target exclusively.
Environment variable: QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__TAG
|
string |
|
quarkus.knative.traffic."traffic".revision-name
RevisionName of a specific revision to which to send this portion of traffic.
Environment variable: QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__REVISION_NAME
|
string |
|
quarkus.knative.traffic."traffic".latest-revision
LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty.
Environment variable: QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__LATEST_REVISION
|
boolean |
false
|
quarkus.knative.traffic."traffic".percent
Percent indicates that percentage based routing should be used and the value indicates the percent of traffic that is to be routed to this Revision or Configuration. 0 (zero) mean no traffic, 100 means all traffic.
Environment variable: QUARKUS_KNATIVE_TRAFFIC__TRAFFIC__PERCENT
|
long |
100
|
quarkus.knative.app-secret
If set, the secret will mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_KNATIVE_APP_SECRET
|
string |
|
quarkus.knative.app-config-map
If set, the config map will be mounted to the application container and its contents will be used for application configuration.
Environment variable: QUARKUS_KNATIVE_APP_CONFIG_MAP
|
string |
|
quarkus.knative.security-context.se-linux-options.level
The SELinux level label that applies to the container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_LEVEL
|
string |
|
quarkus.knative.security-context.se-linux-options.role
The SELinux role label that applies to the container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_ROLE
|
string |
|
quarkus.knative.security-context.se-linux-options.type
The SELinux type label that applies to the container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_TYPE
|
string |
|
quarkus.knative.security-context.se-linux-options.user
The SELinux user label that applies to the container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SE_LINUX_OPTIONS_USER
|
string |
|
quarkus.knative.security-context.windows-options.gmsa-credential-spec-name
The name of the GMSA credential spec to use.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC_NAME
|
string |
|
quarkus.knative.security-context.windows-options.gmsa-credential-spec
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_GMSA_CREDENTIAL_SPEC
|
string |
|
quarkus.knative.security-context.windows-options.run-as-user-name
The UserName in Windows to run the entrypoint of the container process.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_RUN_AS_USER_NAME
|
string |
|
quarkus.knative.security-context.windows-options.host-process
HostProcess determines if a container should be run as a 'Host Process' container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_WINDOWS_OPTIONS_HOST_PROCESS
|
boolean |
|
quarkus.knative.security-context.run-as-user
The UID to run the entrypoint of the container process.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_USER
|
long |
|
quarkus.knative.security-context.run-as-group
The GID to run the entrypoint of the container process.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_GROUP
|
long |
|
quarkus.knative.security-context.run-as-non-root
Indicates that the container must run as a non-root user.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_RUN_AS_NON_ROOT
|
boolean |
|
quarkus.knative.security-context.supplemental-groups
A list of groups applied to the first process run in each container, in addition to the container’s primary GID. If unspecified, no groups will be added to any container.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SUPPLEMENTAL_GROUPS
|
list of long |
|
quarkus.knative.security-context.fs-group
A special supplemental group that applies to all containers in a pod.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP
|
long |
|
quarkus.knative.security-context.sysctls."sysctl-name"
Sysctls hold a list of namespaced sysctls used for the pod.
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_SYSCTLS__SYSCTL_NAME_
|
Map<String,String> |
|
quarkus.knative.security-context.fs-group-change-policy
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always
Environment variable: QUARKUS_KNATIVE_SECURITY_CONTEXT_FS_GROUP_CHANGE_POLICY
|
|
|
If set to true, Quarkus will attempt to deploy the application to the target knative cluster
Environment variable: QUARKUS_KNATIVE_DEPLOY
|
boolean |
false
|
quarkus.knative.deploy-strategy
If deploy is enabled, it will follow this strategy to update the resources to the target Knative cluster.
Environment variable: QUARKUS_KNATIVE_DEPLOY_STRATEGY
|
create-or-update , create , replace , server-side-apply
|
create-or-update
|
Kubernetes Client Internal |
Type |
Default |
quarkus.kubernetes-client.trust-certs
Whether the client should trust a self-signed certificate if so presented by the API server
Environment variable: QUARKUS_KUBERNETES_CLIENT_TRUST_CERTS
|
boolean |
|
quarkus.kubernetes-client.api-server-url
URL of the Kubernetes API server
Environment variable: QUARKUS_KUBERNETES_CLIENT_API_SERVER_URL
|
string |
|
quarkus.kubernetes-client.namespace
Environment variable: QUARKUS_KUBERNETES_CLIENT_NAMESPACE
|
string |
|
quarkus.kubernetes-client.ca-cert-file
Environment variable: QUARKUS_KUBERNETES_CLIENT_CA_CERT_FILE
|
string |
|
quarkus.kubernetes-client.ca-cert-data
Environment variable: QUARKUS_KUBERNETES_CLIENT_CA_CERT_DATA
|
string |
|
quarkus.kubernetes-client.client-cert-file
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_FILE
|
string |
|
quarkus.kubernetes-client.client-cert-data
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_CERT_DATA
|
string |
|
quarkus.kubernetes-client.client-key-file
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_FILE
|
string |
|
quarkus.kubernetes-client.client-key-data
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_DATA
|
string |
|
quarkus.kubernetes-client.client-key-algo
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_ALGO
|
string |
|
quarkus.kubernetes-client.client-key-passphrase
Environment variable: QUARKUS_KUBERNETES_CLIENT_CLIENT_KEY_PASSPHRASE
|
string |
|
quarkus.kubernetes-client.username
Environment variable: QUARKUS_KUBERNETES_CLIENT_USERNAME
|
string |
|
quarkus.kubernetes-client.password
Environment variable: QUARKUS_KUBERNETES_CLIENT_PASSWORD
|
string |
|
quarkus.kubernetes-client.token
Environment variable: QUARKUS_KUBERNETES_CLIENT_TOKEN
|
string |
|
quarkus.kubernetes-client.watch-reconnect-interval
Environment variable: QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_INTERVAL
|
Duration |
PT1S
|
quarkus.kubernetes-client.watch-reconnect-limit
Maximum reconnect attempts in case of watch failure By default there is no limit to the number of reconnect attempts
Environment variable: QUARKUS_KUBERNETES_CLIENT_WATCH_RECONNECT_LIMIT
|
int |
-1
|
quarkus.kubernetes-client.connection-timeout
Maximum amount of time to wait for a connection with the API server to be established
Environment variable: QUARKUS_KUBERNETES_CLIENT_CONNECTION_TIMEOUT
|
Duration |
PT10S
|
quarkus.kubernetes-client.request-timeout
Maximum amount of time to wait for a request to the API server to be completed
Environment variable: QUARKUS_KUBERNETES_CLIENT_REQUEST_TIMEOUT
|
Duration |
PT10S
|
quarkus.kubernetes-client.request-retry-backoff-limit
Maximum number of retry attempts for API requests that fail with an HTTP code of >= 500
Environment variable: QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_LIMIT
|
int |
0
|
quarkus.kubernetes-client.request-retry-backoff-interval
Time interval between retry attempts for API requests that fail with an HTTP code of >= 500
Environment variable: QUARKUS_KUBERNETES_CLIENT_REQUEST_RETRY_BACKOFF_INTERVAL
|
Duration |
PT1S
|
quarkus.kubernetes-client.http-proxy
HTTP proxy used to access the Kubernetes API server
Environment variable: QUARKUS_KUBERNETES_CLIENT_HTTP_PROXY
|
string |
|
quarkus.kubernetes-client.https-proxy
HTTPS proxy used to access the Kubernetes API server
Environment variable: QUARKUS_KUBERNETES_CLIENT_HTTPS_PROXY
|
string |
|
quarkus.kubernetes-client.proxy-username
Environment variable: QUARKUS_KUBERNETES_CLIENT_PROXY_USERNAME
|
string |
|
quarkus.kubernetes-client.proxy-password
Environment variable: QUARKUS_KUBERNETES_CLIENT_PROXY_PASSWORD
|
string |
|
quarkus.kubernetes-client.no-proxy
IP addresses or hosts to exclude from proxying
Environment variable: QUARKUS_KUBERNETES_CLIENT_NO_PROXY
|
list of string |
|
quarkus.kubernetes-client.generate-rbac
Enable the generation of the RBAC manifests. If enabled and no other role binding are provided using the properties quarkus.kubernetes.rbac. , it will generate a default role binding using the role "view" and the application service account.
Environment variable: QUARKUS_KUBERNETES_CLIENT_GENERATE_RBAC
|
boolean |
true
|
Dev Services |
Type |
Default |
quarkus.kubernetes-client.devservices.enabled
If Dev Services for Kubernetes should be used. (default to true) If this is true and kubernetes client is not configured then a kubernetes cluster will be started and will be used.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.kubernetes-client.devservices.api-version
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_API_VERSION
|
string |
|
quarkus.kubernetes-client.devservices.flavor
The flavor to use (kind, k3s or api-only). Default to api-only.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_FLAVOR
|
|
api-only
|
quarkus.kubernetes-client.devservices.override-kubeconfig
By default, if a kubeconfig is found, Dev Services for Kubernetes will not start. Set this to true to override the kubeconfig config.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_OVERRIDE_KUBECONFIG
|
boolean |
false
|
quarkus.kubernetes-client.devservices.shared
Indicates if the Kubernetes cluster 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 Kubernetes starts a new container.
The discovery uses the quarkus-dev-service-kubernetes label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.kubernetes-client.devservices.service-name
The value of the quarkus-dev-service-kubernetes 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 Kubernetes looks for a container with the quarkus-dev-service-kubernetes 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-kubernetes label set to the specified value.
This property is used when you need multiple shared Kubernetes clusters.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_SERVICE_NAME
|
string |
kubernetes
|
quarkus.kubernetes-client.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_KUBERNETES_CLIENT_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Kubernetes Config |
Type |
Default |
quarkus.kubernetes-config.secrets.enabled
Whether configuration can be read from secrets. If set to true , Kubernetes resources allowing access to secrets (role and role binding) will be generated.
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS_ENABLED
|
boolean |
false
|
quarkus.kubernetes-config.secrets-role-config.name
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS_ROLE_CONFIG_NAME
|
string |
view-secrets
|
quarkus.kubernetes-config.secrets-role-config.namespace
The namespace of the role.
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS_ROLE_CONFIG_NAMESPACE
|
string |
|
quarkus.kubernetes-config.secrets-role-config.cluster-wide
Whether the role is cluster wide or not. By default, it’s not a cluster wide role.
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS_ROLE_CONFIG_CLUSTER_WIDE
|
boolean |
false
|
quarkus.kubernetes-config.secrets-role-config.generate
If the current role is meant to be generated or not. If not, it will only be used to generate the role binding resource.
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS_ROLE_CONFIG_GENERATE
|
boolean |
true
|
quarkus.kubernetes-config.enabled
If set to true, the application will attempt to look up the configuration from the API server
Environment variable: QUARKUS_KUBERNETES_CONFIG_ENABLED
|
boolean |
false
|
quarkus.kubernetes-config.fail-on-missing-config
If set to true, the application will not start if any of the configured config sources cannot be located
Environment variable: QUARKUS_KUBERNETES_CONFIG_FAIL_ON_MISSING_CONFIG
|
boolean |
true
|
quarkus.kubernetes-config.config-maps
ConfigMaps to look for in the namespace that the Kubernetes Client has been configured for. ConfigMaps defined later in this list have a higher priority that ConfigMaps defined earlier in this list. Furthermore, any Secrets defined in secrets , will have higher priorities than all ConfigMaps.
Environment variable: QUARKUS_KUBERNETES_CONFIG_CONFIG_MAPS
|
list of string |
|
quarkus.kubernetes-config.secrets
Secrets to look for in the namespace that the Kubernetes Client has been configured for. If you use this, you probably want to enable quarkus.kubernetes-config.secrets.enabled . Secrets defined later in this list have a higher priority that ConfigMaps defined earlier in this list. Furthermore, these Secrets have a higher priorities than all ConfigMaps defined in configMaps .
Environment variable: QUARKUS_KUBERNETES_CONFIG_SECRETS
|
list of string |
|
quarkus.kubernetes-config.namespace
Namespace to look for config maps and secrets. If this is not specified, then the namespace configured in the kubectl config context is used. If the value is specified and the namespace doesn’t exist, the application will fail to start.
Environment variable: QUARKUS_KUBERNETES_CONFIG_NAMESPACE
|
string |
|
Kubernetes Service Binding |
Type |
Default |
quarkus.kubernetes-service-binding.mount-path
The mountPath to add in the ServiceBinding resource.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_MOUNT_PATH
|
string |
|
quarkus.kubernetes-service-binding.bind-as-files
Determines if binding should be created as files or env vars. Set this value to false to bind as env vars.`
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_BIND_AS_FILES
|
boolean |
true
|
quarkus.kubernetes-service-binding.detect-binding-resources
Detects the binding data from resources owned by the backing service.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_DETECT_BINDING_RESOURCES
|
boolean |
false
|
quarkus.kubernetes-service-binding.enabled
If enabled, Service Bindings will be looked in the file system
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_ENABLED
|
boolean |
true
|
quarkus.kubernetes-service-binding.root
The bindings file system root. Specified by the Kubernetes Service ServiceBinding Specification.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_ROOT
|
string |
${SERVICE_BINDING_ROOT:}
|
quarkus.kubernetes-service-binding.services."services".binding
The name of the service binding. If no value is specified the id of the service will be used instead.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_SERVICES__SERVICES__BINDING
|
string |
|
quarkus.kubernetes-service-binding.services."services".kind
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_SERVICES__SERVICES__KIND
|
string |
|
quarkus.kubernetes-service-binding.services."services".api-version
The apiVersion of the service
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_SERVICES__SERVICES__API_VERSION
|
string |
|
quarkus.kubernetes-service-binding.services."services".name
The name of the service. When this is empty the key of the service is meant to be used as name.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_SERVICES__SERVICES__NAME
|
string |
|
quarkus.kubernetes-service-binding.services."services".namespace
The namespace of the service.
Environment variable: QUARKUS_KUBERNETES_SERVICE_BINDING_SERVICES__SERVICES__NAMESPACE
|
string |
|
Liquibase |
Type |
Default |
quarkus.liquibase.change-log
The liquibase change log file. All included change log files in this file are scanned and add to the projects.
Environment variable: QUARKUS_LIQUIBASE_CHANGE_LOG
|
string |
db/changeLog.xml
|
quarkus.liquibase.search-path
The search path for DirectoryResourceAccessor
Environment variable: QUARKUS_LIQUIBASE_SEARCH_PATH
|
list of string |
|
quarkus.liquibase.enabled
Flag to enable / disable Liquibase.
Environment variable: QUARKUS_LIQUIBASE_ENABLED
|
boolean |
true
|
quarkus.liquibase.migrate-at-start
true to execute Liquibase automatically when the application starts, false otherwise.
Environment variable: QUARKUS_LIQUIBASE_MIGRATE_AT_START
|
boolean |
false
|
quarkus.liquibase.validate-on-migrate
true to validate the applied changes against the available ones, false otherwise. It is only used if migration-at-start is true
Environment variable: QUARKUS_LIQUIBASE_VALIDATE_ON_MIGRATE
|
boolean |
true
|
quarkus.liquibase.clean-at-start
true to execute Liquibase clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_LIQUIBASE_CLEAN_AT_START
|
boolean |
false
|
quarkus.liquibase.contexts
Comma-separated case-sensitive list of ChangeSet contexts to execute for liquibase.
Environment variable: QUARKUS_LIQUIBASE_CONTEXTS
|
list of string |
|
Comma-separated case-sensitive list of expressions defining labeled ChangeSet to execute for liquibase.
Environment variable: QUARKUS_LIQUIBASE_LABELS
|
list of string |
|
quarkus.liquibase.change-log-parameters."parameter-name"
Map of parameters that can be used inside Liquibase changeLog files.
Environment variable: QUARKUS_LIQUIBASE_CHANGE_LOG_PARAMETERS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.liquibase.database-change-log-lock-table-name
The liquibase change log lock table name. Name of table to use for tracking concurrent Liquibase usage.
Environment variable: QUARKUS_LIQUIBASE_DATABASE_CHANGE_LOG_LOCK_TABLE_NAME
|
string |
DATABASECHANGELOGLOCK
|
quarkus.liquibase.database-change-log-table-name
The liquibase change log table name. Name of table to use for tracking change history.
Environment variable: QUARKUS_LIQUIBASE_DATABASE_CHANGE_LOG_TABLE_NAME
|
string |
DATABASECHANGELOG
|
quarkus.liquibase.default-catalog-name
The name of Liquibase’s default catalog.
Environment variable: QUARKUS_LIQUIBASE_DEFAULT_CATALOG_NAME
|
string |
|
quarkus.liquibase.default-schema-name
The name of Liquibase’s default schema. Overwrites the default schema name (returned by the RDBMS) with a different database schema.
Environment variable: QUARKUS_LIQUIBASE_DEFAULT_SCHEMA_NAME
|
string |
|
quarkus.liquibase.username
The username that Liquibase uses to connect to the database. If no specific username is configured, falls back to the datasource username and password.
Environment variable: QUARKUS_LIQUIBASE_USERNAME
|
string |
|
quarkus.liquibase.password
The password that Liquibase uses to connect to the database. If no specific password is configured, falls back to the datasource username and password.
Environment variable: QUARKUS_LIQUIBASE_PASSWORD
|
string |
|
quarkus.liquibase.liquibase-catalog-name
The name of the catalog with the liquibase tables.
Environment variable: QUARKUS_LIQUIBASE_LIQUIBASE_CATALOG_NAME
|
string |
|
quarkus.liquibase.liquibase-schema-name
The name of the schema with the liquibase tables.
Environment variable: QUARKUS_LIQUIBASE_LIQUIBASE_SCHEMA_NAME
|
string |
|
quarkus.liquibase.liquibase-tablespace-name
The name of the tablespace where the -LOG and -LOCK tables will be created (if they do not exist yet).
Environment variable: QUARKUS_LIQUIBASE_LIQUIBASE_TABLESPACE_NAME
|
string |
|
quarkus.liquibase.allow-duplicated-changeset-identifiers
Allows duplicated changeset identifiers without failing Liquibase execution.
Environment variable: QUARKUS_LIQUIBASE_ALLOW_DUPLICATED_CHANGESET_IDENTIFIERS
|
boolean |
|
Named datasources |
Type |
Default |
quarkus.liquibase."datasource-name".change-log
The liquibase change log file. All included change log files in this file are scanned and add to the projects.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__CHANGE_LOG
|
string |
db/changeLog.xml
|
quarkus.liquibase."datasource-name".search-path
The search path for DirectoryResourceAccessor
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__SEARCH_PATH
|
list of string |
|
quarkus.liquibase."datasource-name".migrate-at-start
true to execute Liquibase automatically when the application starts, false otherwise.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__MIGRATE_AT_START
|
boolean |
false
|
quarkus.liquibase."datasource-name".validate-on-migrate
true to validate the applied changes against the available ones, false otherwise. It is only used if migration-at-start is true
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__VALIDATE_ON_MIGRATE
|
boolean |
true
|
quarkus.liquibase."datasource-name".clean-at-start
true to execute Liquibase clean command automatically when the application starts, false otherwise.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__CLEAN_AT_START
|
boolean |
false
|
quarkus.liquibase."datasource-name".contexts
Comma-separated case-sensitive list of ChangeSet contexts to execute for liquibase.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__CONTEXTS
|
list of string |
|
quarkus.liquibase."datasource-name".labels
Comma-separated case-sensitive list of expressions defining labeled ChangeSet to execute for liquibase.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__LABELS
|
list of string |
|
quarkus.liquibase."datasource-name".change-log-parameters."parameter-name"
Map of parameters that can be used inside Liquibase changeLog files.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__CHANGE_LOG_PARAMETERS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.liquibase."datasource-name".database-change-log-lock-table-name
The liquibase change log lock table name. Name of table to use for tracking concurrent Liquibase usage.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__DATABASE_CHANGE_LOG_LOCK_TABLE_NAME
|
string |
DATABASECHANGELOGLOCK
|
quarkus.liquibase."datasource-name".database-change-log-table-name
The liquibase change log table name. Name of table to use for tracking change history.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__DATABASE_CHANGE_LOG_TABLE_NAME
|
string |
DATABASECHANGELOG
|
quarkus.liquibase."datasource-name".default-catalog-name
The name of Liquibase’s default catalog.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__DEFAULT_CATALOG_NAME
|
string |
|
quarkus.liquibase."datasource-name".default-schema-name
The name of Liquibase’s default schema. Overwrites the default schema name (returned by the RDBMS) with a different database schema.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__DEFAULT_SCHEMA_NAME
|
string |
|
quarkus.liquibase."datasource-name".username
The username that Liquibase uses to connect to the database. If no specific username is configured, falls back to the datasource username and password.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__USERNAME
|
string |
|
quarkus.liquibase."datasource-name".password
The password that Liquibase uses to connect to the database. If no specific password is configured, falls back to the datasource username and password.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__PASSWORD
|
string |
|
quarkus.liquibase."datasource-name".liquibase-catalog-name
The name of the catalog with the liquibase tables.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__LIQUIBASE_CATALOG_NAME
|
string |
|
quarkus.liquibase."datasource-name".liquibase-schema-name
The name of the schema with the liquibase tables.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__LIQUIBASE_SCHEMA_NAME
|
string |
|
quarkus.liquibase."datasource-name".liquibase-tablespace-name
The name of the tablespace where the -LOG and -LOCK tables will be created (if they do not exist yet).
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__LIQUIBASE_TABLESPACE_NAME
|
string |
|
quarkus.liquibase."datasource-name".allow-duplicated-changeset-identifiers
Allows duplicated changeset identifiers without failing Liquibase execution.
Environment variable: QUARKUS_LIQUIBASE__DATASOURCE_NAME__ALLOW_DUPLICATED_CHANGESET_IDENTIFIERS
|
boolean |
|
Liquibase MongoDB |
Type |
Default |
quarkus.liquibase-mongodb.change-log
Environment variable: QUARKUS_LIQUIBASE_MONGODB_CHANGE_LOG
|
string |
db/changeLog.xml
|
quarkus.liquibase-mongodb.search-path
The search path for DirectoryResourceAccessor
Environment variable: QUARKUS_LIQUIBASE_MONGODB_SEARCH_PATH
|
list of string |
|
quarkus.liquibase-mongodb.enabled
Flag to enable / disable Liquibase.
Environment variable: QUARKUS_LIQUIBASE_MONGODB_ENABLED
|
boolean |
true
|
quarkus.liquibase-mongodb.migrate-at-start
The migrate at start flag
Environment variable: QUARKUS_LIQUIBASE_MONGODB_MIGRATE_AT_START
|
boolean |
false
|
quarkus.liquibase-mongodb.validate-on-migrate
The validate on update flag
Environment variable: QUARKUS_LIQUIBASE_MONGODB_VALIDATE_ON_MIGRATE
|
boolean |
true
|
quarkus.liquibase-mongodb.clean-at-start
Environment variable: QUARKUS_LIQUIBASE_MONGODB_CLEAN_AT_START
|
boolean |
false
|
quarkus.liquibase-mongodb.change-log-parameters."change-log-parameters"
The parameters to be passed to the changelog. Defined as key value pairs.
Environment variable: QUARKUS_LIQUIBASE_MONGODB_CHANGE_LOG_PARAMETERS__CHANGE_LOG_PARAMETERS_
|
Map<String,String> |
|
quarkus.liquibase-mongodb.contexts
Environment variable: QUARKUS_LIQUIBASE_MONGODB_CONTEXTS
|
list of string |
|
quarkus.liquibase-mongodb.labels
Environment variable: QUARKUS_LIQUIBASE_MONGODB_LABELS
|
list of string |
|
quarkus.liquibase-mongodb.default-catalog-name
Environment variable: QUARKUS_LIQUIBASE_MONGODB_DEFAULT_CATALOG_NAME
|
string |
|
quarkus.liquibase-mongodb.default-schema-name
Environment variable: QUARKUS_LIQUIBASE_MONGODB_DEFAULT_SCHEMA_NAME
|
string |
|
quarkus.liquibase-mongodb.liquibase-catalog-name
The liquibase tables catalog name
Environment variable: QUARKUS_LIQUIBASE_MONGODB_LIQUIBASE_CATALOG_NAME
|
string |
|
quarkus.liquibase-mongodb.liquibase-schema-name
The liquibase tables schema name
Environment variable: QUARKUS_LIQUIBASE_MONGODB_LIQUIBASE_SCHEMA_NAME
|
string |
|
quarkus.liquibase-mongodb.liquibase-tablespace-name
The liquibase tables tablespace name
Environment variable: QUARKUS_LIQUIBASE_MONGODB_LIQUIBASE_TABLESPACE_NAME
|
string |
|
Load Shedding |
Type |
Default |
quarkus.load-shedding.enabled
Whether load shedding should be enabled. Currently, this only applies to incoming HTTP requests.
Environment variable: QUARKUS_LOAD_SHEDDING_ENABLED
|
boolean |
true
|
quarkus.load-shedding.max-limit
The maximum number of concurrent requests allowed.
Environment variable: QUARKUS_LOAD_SHEDDING_MAX_LIMIT
|
int |
1000
|
quarkus.load-shedding.alpha-factor
The alpha factor of the Vegas overload detection algorithm.
Environment variable: QUARKUS_LOAD_SHEDDING_ALPHA_FACTOR
|
int |
3
|
quarkus.load-shedding.beta-factor
The beta factor of the Vegas overload detection algorithm.
Environment variable: QUARKUS_LOAD_SHEDDING_BETA_FACTOR
|
int |
6
|
quarkus.load-shedding.probe-factor
The probe factor of the Vegas overload detection algorithm.
Environment variable: QUARKUS_LOAD_SHEDDING_PROBE_FACTOR
|
double |
30.0
|
quarkus.load-shedding.initial-limit
The initial limit of concurrent requests allowed.
Environment variable: QUARKUS_LOAD_SHEDDING_INITIAL_LIMIT
|
int |
100
|
quarkus.load-shedding.priority.enabled
Whether priority load shedding should be enabled.
Environment variable: QUARKUS_LOAD_SHEDDING_PRIORITY_ENABLED
|
boolean |
true
|
Logging GELF |
Type |
Default |
quarkus.log.handler.gelf.enabled
Determine whether to enable the GELF logging handler
Environment variable: QUARKUS_LOG_HANDLER_GELF_ENABLED
|
boolean |
false
|
quarkus.log.handler.gelf.host
Hostname/IP-Address of the Logstash/Graylog Host By default it uses UDP, prepend tcp: to the hostname to switch to TCP, example: "tcp:localhost"
Environment variable: QUARKUS_LOG_HANDLER_GELF_HOST
|
string |
localhost
|
quarkus.log.handler.gelf.port
Environment variable: QUARKUS_LOG_HANDLER_GELF_PORT
|
int |
12201
|
quarkus.log.handler.gelf.version
Environment variable: QUARKUS_LOG_HANDLER_GELF_VERSION
|
string |
1.1
|
quarkus.log.handler.gelf.extract-stack-trace
Whether to post Stack-Trace to StackTrace field.
Environment variable: QUARKUS_LOG_HANDLER_GELF_EXTRACT_STACK_TRACE
|
boolean |
true
|
quarkus.log.handler.gelf.stack-trace-throwable-reference
Only used when extractStackTrace is true . A value of 0 will extract the whole stack trace. Any positive value will walk the cause chain: 1 corresponds with exception.getCause(), 2 with exception.getCause().getCause(), … Negative throwable reference walk the exception chain from the root cause side: -1 will extract the root cause, -2 the exception wrapping the root cause, …
Environment variable: QUARKUS_LOG_HANDLER_GELF_STACK_TRACE_THROWABLE_REFERENCE
|
int |
0
|
quarkus.log.handler.gelf.filter-stack-trace
Whether to perform Stack-Trace filtering
Environment variable: QUARKUS_LOG_HANDLER_GELF_FILTER_STACK_TRACE
|
boolean |
false
|
quarkus.log.handler.gelf.timestamp-pattern
Java date pattern, see java.text.SimpleDateFormat
Environment variable: QUARKUS_LOG_HANDLER_GELF_TIMESTAMP_PATTERN
|
string |
yyyy-MM-dd HH:mm:ss,SSS
|
quarkus.log.handler.gelf.level
The logging-gelf log level.
Environment variable: QUARKUS_LOG_HANDLER_GELF_LEVEL
|
Level |
ALL
|
quarkus.log.handler.gelf.facility
Environment variable: QUARKUS_LOG_HANDLER_GELF_FACILITY
|
string |
jboss-logmanager
|
Post additional fields |
Type |
Default |
quarkus.log.handler.gelf.additional-field."field-name".value
Environment variable: QUARKUS_LOG_HANDLER_GELF_ADDITIONAL_FIELD__FIELD_NAME__VALUE
|
string |
required |
quarkus.log.handler.gelf.additional-field."field-name".type
Additional field type specification. Supported types: String, long, Long, double, Double and discover. Discover is the default if not specified, it discovers field type based on parseability.
Environment variable: QUARKUS_LOG_HANDLER_GELF_ADDITIONAL_FIELD__FIELD_NAME__TYPE
|
string |
discover
|
quarkus.log.handler.gelf.include-full-mdc
Whether to include all fields from the MDC.
Environment variable: QUARKUS_LOG_HANDLER_GELF_INCLUDE_FULL_MDC
|
boolean |
false
|
quarkus.log.handler.gelf.mdc-fields
Send additional fields whose values are obtained from MDC. Name of the Fields are comma-separated. Example: mdcFields=Application,Version,SomeOtherFieldName
Environment variable: QUARKUS_LOG_HANDLER_GELF_MDC_FIELDS
|
string |
|
quarkus.log.handler.gelf.dynamic-mdc-fields
Dynamic MDC Fields allows you to extract MDC values based on one or more regular expressions. Multiple regexes are comma-separated. The name of the MDC entry is used as GELF field name.
Environment variable: QUARKUS_LOG_HANDLER_GELF_DYNAMIC_MDC_FIELDS
|
string |
|
quarkus.log.handler.gelf.dynamic-mdc-field-types
Pattern-based type specification for additional and MDC fields. Key-value pairs are comma-separated. Example: my_field.*=String,business\..*\.field=double
Environment variable: QUARKUS_LOG_HANDLER_GELF_DYNAMIC_MDC_FIELD_TYPES
|
string |
|
quarkus.log.handler.gelf.maximum-message-size
Maximum message size (in bytes). If the message size is exceeded, the appender will submit the message in multiple chunks.
Environment variable: QUARKUS_LOG_HANDLER_GELF_MAXIMUM_MESSAGE_SIZE
|
int |
8192
|
quarkus.log.handler.gelf.include-log-message-parameters
Include message parameters from the log event
Environment variable: QUARKUS_LOG_HANDLER_GELF_INCLUDE_LOG_MESSAGE_PARAMETERS
|
boolean |
true
|
quarkus.log.handler.gelf.include-location
Include source code location
Environment variable: QUARKUS_LOG_HANDLER_GELF_INCLUDE_LOCATION
|
boolean |
true
|
quarkus.log.handler.gelf.origin-host
Environment variable: QUARKUS_LOG_HANDLER_GELF_ORIGIN_HOST
|
string |
|
quarkus.log.handler.gelf.skip-hostname-resolution
Bypass hostname resolution. If you didn’t set the originHost property, and resolution is disabled, the value “unknown” will be used as hostname
Environment variable: QUARKUS_LOG_HANDLER_GELF_SKIP_HOSTNAME_RESOLUTION
|
boolean |
false
|
Logging JSON |
Type |
Default |
Console logging |
Type |
Default |
Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.
Environment variable: QUARKUS_LOG_CONSOLE_JSON
|
boolean |
true
|
quarkus.log.console.json.pretty-print
Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_PRETTY_PRINT
|
boolean |
false
|
quarkus.log.console.json.date-format
The date format to use. The special string "default" indicates that the default format should be used.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_DATE_FORMAT
|
string |
default
|
quarkus.log.console.json.record-delimiter
The special end-of-record delimiter to be used. By default, newline is used.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_RECORD_DELIMITER
|
string |
|
quarkus.log.console.json.zone-id
The zone ID to use. The special string "default" indicates that the default zone should be used.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_ZONE_ID
|
string |
default
|
quarkus.log.console.json.exception-output-type
The exception output type to specify.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_EXCEPTION_OUTPUT_TYPE
|
detailed , formatted , detailed-and-formatted
|
detailed
|
quarkus.log.console.json.print-details
Enable printing of more details in the log.
Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_PRINT_DETAILS
|
boolean |
false
|
quarkus.log.console.json.key-overrides
Override keys with custom values. Omitting this value indicates that no key overrides will be applied.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_KEY_OVERRIDES
|
string |
|
quarkus.log.console.json.excluded-keys
Keys to be excluded from the JSON output.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_EXCLUDED_KEYS
|
list of string |
|
quarkus.log.console.json.additional-field."field-name".value
Environment variable: QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE
|
string |
required |
quarkus.log.console.json.additional-field."field-name".type
Additional field type specification. Supported types: string , int , and long . String is the default if not specified.
Environment variable: QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE
|
|
string
|
File logging |
Type |
Default |
Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.
Environment variable: QUARKUS_LOG_FILE_JSON
|
boolean |
true
|
quarkus.log.file.json.pretty-print
Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.
Environment variable: QUARKUS_LOG_FILE_JSON_PRETTY_PRINT
|
boolean |
false
|
quarkus.log.file.json.date-format
The date format to use. The special string "default" indicates that the default format should be used.
Environment variable: QUARKUS_LOG_FILE_JSON_DATE_FORMAT
|
string |
default
|
quarkus.log.file.json.record-delimiter
The special end-of-record delimiter to be used. By default, newline is used.
Environment variable: QUARKUS_LOG_FILE_JSON_RECORD_DELIMITER
|
string |
|
quarkus.log.file.json.zone-id
The zone ID to use. The special string "default" indicates that the default zone should be used.
Environment variable: QUARKUS_LOG_FILE_JSON_ZONE_ID
|
string |
default
|
quarkus.log.file.json.exception-output-type
The exception output type to specify.
Environment variable: QUARKUS_LOG_FILE_JSON_EXCEPTION_OUTPUT_TYPE
|
detailed , formatted , detailed-and-formatted
|
detailed
|
quarkus.log.file.json.print-details
Enable printing of more details in the log.
Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.
Environment variable: QUARKUS_LOG_FILE_JSON_PRINT_DETAILS
|
boolean |
false
|
quarkus.log.file.json.key-overrides
Override keys with custom values. Omitting this value indicates that no key overrides will be applied.
Environment variable: QUARKUS_LOG_FILE_JSON_KEY_OVERRIDES
|
string |
|
quarkus.log.file.json.excluded-keys
Keys to be excluded from the JSON output.
Environment variable: QUARKUS_LOG_FILE_JSON_EXCLUDED_KEYS
|
list of string |
|
quarkus.log.file.json.additional-field."field-name".value
Environment variable: QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE
|
string |
required |
quarkus.log.file.json.additional-field."field-name".type
Additional field type specification. Supported types: string , int , and long . String is the default if not specified.
Environment variable: QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE
|
|
string
|
Syslog logging |
Type |
Default |
Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.
Environment variable: QUARKUS_LOG_SYSLOG_JSON
|
boolean |
true
|
quarkus.log.syslog.json.pretty-print
Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_PRETTY_PRINT
|
boolean |
false
|
quarkus.log.syslog.json.date-format
The date format to use. The special string "default" indicates that the default format should be used.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_DATE_FORMAT
|
string |
default
|
quarkus.log.syslog.json.record-delimiter
The special end-of-record delimiter to be used. By default, newline is used.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_RECORD_DELIMITER
|
string |
|
quarkus.log.syslog.json.zone-id
The zone ID to use. The special string "default" indicates that the default zone should be used.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_ZONE_ID
|
string |
default
|
quarkus.log.syslog.json.exception-output-type
The exception output type to specify.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_EXCEPTION_OUTPUT_TYPE
|
detailed , formatted , detailed-and-formatted
|
detailed
|
quarkus.log.syslog.json.print-details
Enable printing of more details in the log.
Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_PRINT_DETAILS
|
boolean |
false
|
quarkus.log.syslog.json.key-overrides
Override keys with custom values. Omitting this value indicates that no key overrides will be applied.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_KEY_OVERRIDES
|
string |
|
quarkus.log.syslog.json.excluded-keys
Keys to be excluded from the JSON output.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_EXCLUDED_KEYS
|
list of string |
|
quarkus.log.syslog.json.additional-field."field-name".value
Environment variable: QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE
|
string |
required |
quarkus.log.syslog.json.additional-field."field-name".type
Additional field type specification. Supported types: string , int , and long . String is the default if not specified.
Environment variable: QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE
|
|
string
|
Mailer |
Type |
Default |
quarkus.mailer.cache-attachments
Caches data from attachment’s Stream to a temporary file. It tries to delete it after sending email.
Environment variable: QUARKUS_MAILER_CACHE_ATTACHMENTS
|
boolean |
false
|
Sets the default from attribute when not specified in the io.quarkus.mailer.Mail instance. It’s the sender email address.
Environment variable: QUARKUS_MAILER_FROM
|
string |
|
Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.
Disabled by default on PROD, enabled by default on DEV and TEST modes.
Environment variable: QUARKUS_MAILER_MOCK
|
boolean |
|
quarkus.mailer.bounce-address
Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.
Environment variable: QUARKUS_MAILER_BOUNCE_ADDRESS
|
string |
|
Environment variable: QUARKUS_MAILER_HOST
|
string |
localhost
|
The SMTP port. The default value depends on the configuration. The port 25 is used as default when ssl is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when ssl is enabled. It ensures that email is submitted securely.
Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.
Environment variable: QUARKUS_MAILER_PORT
|
int |
|
Sets the username to connect to the SMTP server.
Environment variable: QUARKUS_MAILER_USERNAME
|
string |
|
Sets the password to connect to the SMTP server.
Environment variable: QUARKUS_MAILER_PASSWORD
|
string |
|
quarkus.mailer.tls-configuration-name
The name of the TLS configuration to use.
If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration name is set then, the specific TLS configuration (from quarkus.mailer.* ) will be used.
The default TLS configuration is not used by default.
Environment variable: QUARKUS_MAILER_TLS_CONFIGURATION_NAME
|
string |
|
Whether the connection should be secured using TLS.
SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to false and start-tls to REQUIRED Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to false is required to not establish a connection with TLS.
Environment variable: QUARKUS_MAILER_TLS
|
boolean |
|
quarkus.mailer.max-pool-size
Sets the max number of open connections to the mail server.
Environment variable: QUARKUS_MAILER_MAX_POOL_SIZE
|
int |
10
|
quarkus.mailer.own-host-name
Sets the hostname to be used for HELO/EHLO and the Message-ID.
Environment variable: QUARKUS_MAILER_OWN_HOST_NAME
|
string |
|
quarkus.mailer.keep-alive
Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.
Environment variable: QUARKUS_MAILER_KEEP_ALIVE
|
boolean |
true
|
quarkus.mailer.disable-esmtp
The RFC-1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use the regular SMTP command.
Environment variable: QUARKUS_MAILER_DISABLE_ESMTP
|
boolean |
false
|
Sets the TLS security mode for the connection. Either DISABLED , OPTIONAL or REQUIRED .
Environment variable: QUARKUS_MAILER_START_TLS
|
string |
OPTIONAL
|
quarkus.mailer.dkim.enabled
Environment variable: QUARKUS_MAILER_DKIM_ENABLED
|
boolean |
false
|
quarkus.mailer.dkim.private-key
Configures the PKCS#8 format private key used to sign the email.
Environment variable: QUARKUS_MAILER_DKIM_PRIVATE_KEY
|
string |
|
quarkus.mailer.dkim.private-key-path
Configures the PKCS#8 format private key file path.
Environment variable: QUARKUS_MAILER_DKIM_PRIVATE_KEY_PATH
|
string |
|
Configures the Agent or User Identifier (AUID).
Environment variable: QUARKUS_MAILER_DKIM_AUID
|
string |
|
quarkus.mailer.dkim.selector
Configures the selector used to query the public key.
Environment variable: QUARKUS_MAILER_DKIM_SELECTOR
|
string |
|
Configures the Signing Domain Identifier (SDID).
Environment variable: QUARKUS_MAILER_DKIM_SDID
|
string |
|
quarkus.mailer.dkim.header-canon-algo
Configures the canonicalization algorithm for signed headers.
Environment variable: QUARKUS_MAILER_DKIM_HEADER_CANON_ALGO
|
|
|
quarkus.mailer.dkim.body-canon-algo
Configures the canonicalization algorithm for mail body.
Environment variable: QUARKUS_MAILER_DKIM_BODY_CANON_ALGO
|
|
|
quarkus.mailer.dkim.body-limit
Configures the body limit to sign. Must be greater than zero.
Environment variable: QUARKUS_MAILER_DKIM_BODY_LIMIT
|
int |
|
quarkus.mailer.dkim.signature-timestamp
Configures to enable or disable signature sign timestamp.
Environment variable: QUARKUS_MAILER_DKIM_SIGNATURE_TIMESTAMP
|
boolean |
|
quarkus.mailer.dkim.expire-time
Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.
Environment variable: QUARKUS_MAILER_DKIM_EXPIRE_TIME
|
long |
|
quarkus.mailer.dkim.signed-headers
Configures the signed headers in DKIM, separated by commas. The order in the list matters.
Environment variable: QUARKUS_MAILER_DKIM_SIGNED_HEADERS
|
list of string |
|
Sets the login mode for the connection. Either NONE , @{code DISABLED}, OPTIONAL , REQUIRED or XOAUTH2 .
-
DISABLED means no login will be attempted
-
NONE means a login will be attempted if the server supports in and login credentials are set
-
REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise
-
XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens
Environment variable: QUARKUS_MAILER_LOGIN
|
string |
NONE
|
quarkus.mailer.auth-methods
Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.
The list is given as a space separated list, such as DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN .
Environment variable: QUARKUS_MAILER_AUTH_METHODS
|
string |
|
quarkus.mailer.multi-part-only
Whether the mail should always been sent as multipart even if they don’t have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.
Environment variable: QUARKUS_MAILER_MULTI_PART_ONLY
|
boolean |
false
|
quarkus.mailer.allow-rcpt-errors
Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.
Environment variable: QUARKUS_MAILER_ALLOW_RCPT_ERRORS
|
boolean |
false
|
quarkus.mailer.pipelining
Enables or disables the pipelining capability if the SMTP server supports it.
Environment variable: QUARKUS_MAILER_PIPELINING
|
boolean |
true
|
quarkus.mailer.pool-cleaner-period
Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.
Environment variable: QUARKUS_MAILER_POOL_CLEANER_PERIOD
|
Duration |
PT1S
|
quarkus.mailer.keep-alive-timeout
Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.
Environment variable: QUARKUS_MAILER_KEEP_ALIVE_TIMEOUT
|
Duration |
PT300S
|
quarkus.mailer.ntlm.workstation
Sets the workstation used on NTLM authentication.
Environment variable: QUARKUS_MAILER_NTLM_WORKSTATION
|
string |
|
quarkus.mailer.ntlm.domain
Sets the domain used on NTLM authentication.
Environment variable: QUARKUS_MAILER_NTLM_DOMAIN
|
string |
|
quarkus.mailer.approved-recipients
Allows sending emails to these recipients only.
Approved recipients are compiled to a Pattern and must be a valid regular expression. The created Pattern is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.
Environment variable: QUARKUS_MAILER_APPROVED_RECIPIENTS
|
list of Pattern |
|
quarkus.mailer.log-rejected-recipients
Log rejected recipients as warnings.
If false, the rejected recipients will be logged at the DEBUG level.
Environment variable: QUARKUS_MAILER_LOG_REJECTED_RECIPIENTS
|
boolean |
false
|
Additional named mailers |
Type |
Default |
quarkus.mailer."mailer-name".from
Sets the default from attribute when not specified in the io.quarkus.mailer.Mail instance. It’s the sender email address.
Environment variable: QUARKUS_MAILER__MAILER_NAME__FROM
|
string |
|
quarkus.mailer."mailer-name".mock
Enables the mock mode. When enabled, mails are not sent, but stored in an in-memory mailbox. The content of the emails is also printed on the console.
Disabled by default on PROD, enabled by default on DEV and TEST modes.
Environment variable: QUARKUS_MAILER__MAILER_NAME__MOCK
|
boolean |
|
quarkus.mailer."mailer-name".bounce-address
Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server.
Environment variable: QUARKUS_MAILER__MAILER_NAME__BOUNCE_ADDRESS
|
string |
|
quarkus.mailer."mailer-name".host
Environment variable: QUARKUS_MAILER__MAILER_NAME__HOST
|
string |
localhost
|
quarkus.mailer."mailer-name".port
The SMTP port. The default value depends on the configuration. The port 25 is used as default when ssl is disabled. This port continues to be used primarily for SMTP relaying. SMTP relaying is the transmission of email from email server to email server. The port 587 is the default port when ssl is enabled. It ensures that email is submitted securely.
Note that the port 465 may be used by SMTP servers, however, IANA has reassigned a new service to this port, and it should no longer be used for SMTP communications.
Environment variable: QUARKUS_MAILER__MAILER_NAME__PORT
|
int |
|
quarkus.mailer."mailer-name".username
Sets the username to connect to the SMTP server.
Environment variable: QUARKUS_MAILER__MAILER_NAME__USERNAME
|
string |
|
quarkus.mailer."mailer-name".password
Sets the password to connect to the SMTP server.
Environment variable: QUARKUS_MAILER__MAILER_NAME__PASSWORD
|
string |
|
quarkus.mailer."mailer-name".tls-configuration-name
The name of the TLS configuration to use.
If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration name is set then, the specific TLS configuration (from quarkus.mailer.* ) will be used.
The default TLS configuration is not used by default.
Environment variable: QUARKUS_MAILER__MAILER_NAME__TLS_CONFIGURATION_NAME
|
string |
|
quarkus.mailer."mailer-name".tls
Whether the connection should be secured using TLS.
SMTP allows establishing connection with or without TLS. When establishing a connection with TLS, the connection is secured and encrypted. When establishing a connection without TLS, it can be secured and encrypted later using the STARTTLS command. In this case, the connection is initially unsecured and unencrypted. To configure this case, set this property to false and start-tls to REQUIRED Note that if a TLS configuration is set, TLS is enabled automatically. So, setting this property to false is required to not establish a connection with TLS.
Environment variable: QUARKUS_MAILER__MAILER_NAME__TLS
|
boolean |
|
quarkus.mailer."mailer-name".max-pool-size
Sets the max number of open connections to the mail server.
Environment variable: QUARKUS_MAILER__MAILER_NAME__MAX_POOL_SIZE
|
int |
10
|
quarkus.mailer."mailer-name".own-host-name
Sets the hostname to be used for HELO/EHLO and the Message-ID.
Environment variable: QUARKUS_MAILER__MAILER_NAME__OWN_HOST_NAME
|
string |
|
quarkus.mailer."mailer-name".keep-alive
Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless.
Environment variable: QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE
|
boolean |
true
|
quarkus.mailer."mailer-name".disable-esmtp
The RFC-1869 states that clients should always attempt EHLO as first command to determine if ESMTP is supported, if this returns an error code, HELO is tried to use the regular SMTP command.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DISABLE_ESMTP
|
boolean |
false
|
quarkus.mailer."mailer-name".start-tls
Sets the TLS security mode for the connection. Either DISABLED , OPTIONAL or REQUIRED .
Environment variable: QUARKUS_MAILER__MAILER_NAME__START_TLS
|
string |
OPTIONAL
|
quarkus.mailer."mailer-name".dkim.enabled
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_ENABLED
|
boolean |
false
|
quarkus.mailer."mailer-name".dkim.private-key
Configures the PKCS#8 format private key used to sign the email.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY
|
string |
|
quarkus.mailer."mailer-name".dkim.private-key-path
Configures the PKCS#8 format private key file path.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_PRIVATE_KEY_PATH
|
string |
|
quarkus.mailer."mailer-name".dkim.auid
Configures the Agent or User Identifier (AUID).
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_AUID
|
string |
|
quarkus.mailer."mailer-name".dkim.selector
Configures the selector used to query the public key.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_SELECTOR
|
string |
|
quarkus.mailer."mailer-name".dkim.sdid
Configures the Signing Domain Identifier (SDID).
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_SDID
|
string |
|
quarkus.mailer."mailer-name".dkim.header-canon-algo
Configures the canonicalization algorithm for signed headers.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_HEADER_CANON_ALGO
|
|
|
quarkus.mailer."mailer-name".dkim.body-canon-algo
Configures the canonicalization algorithm for mail body.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_CANON_ALGO
|
|
|
quarkus.mailer."mailer-name".dkim.body-limit
Configures the body limit to sign. Must be greater than zero.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_BODY_LIMIT
|
int |
|
quarkus.mailer."mailer-name".dkim.signature-timestamp
Configures to enable or disable signature sign timestamp.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNATURE_TIMESTAMP
|
boolean |
|
quarkus.mailer."mailer-name".dkim.expire-time
Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_EXPIRE_TIME
|
long |
|
quarkus.mailer."mailer-name".dkim.signed-headers
Configures the signed headers in DKIM, separated by commas. The order in the list matters.
Environment variable: QUARKUS_MAILER__MAILER_NAME__DKIM_SIGNED_HEADERS
|
list of string |
|
quarkus.mailer."mailer-name".login
Sets the login mode for the connection. Either NONE , @{code DISABLED}, OPTIONAL , REQUIRED or XOAUTH2 .
-
DISABLED means no login will be attempted
-
NONE means a login will be attempted if the server supports in and login credentials are set
-
REQUIRED means that a login will be attempted if the server supports it and the send operation will fail otherwise
-
XOAUTH2 means that a login will be attempted using Google Gmail Oauth2 tokens
Environment variable: QUARKUS_MAILER__MAILER_NAME__LOGIN
|
string |
NONE
|
quarkus.mailer."mailer-name".auth-methods
Sets the allowed authentication methods. These methods will be used only if the server supports them. If not set, all supported methods may be used.
The list is given as a space separated list, such as DIGEST-MD5 CRAM-SHA256 CRAM-SHA1 CRAM-MD5 PLAIN LOGIN .
Environment variable: QUARKUS_MAILER__MAILER_NAME__AUTH_METHODS
|
string |
|
quarkus.mailer."mailer-name".multi-part-only
Whether the mail should always been sent as multipart even if they don’t have attachments. When sets to true, the mail message will be encoded as multipart even for simple mails without attachments.
Environment variable: QUARKUS_MAILER__MAILER_NAME__MULTI_PART_ONLY
|
boolean |
false
|
quarkus.mailer."mailer-name".allow-rcpt-errors
Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any.
Environment variable: QUARKUS_MAILER__MAILER_NAME__ALLOW_RCPT_ERRORS
|
boolean |
false
|
quarkus.mailer."mailer-name".pipelining
Enables or disables the pipelining capability if the SMTP server supports it.
Environment variable: QUARKUS_MAILER__MAILER_NAME__PIPELINING
|
boolean |
true
|
quarkus.mailer."mailer-name".pool-cleaner-period
Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed.
Environment variable: QUARKUS_MAILER__MAILER_NAME__POOL_CLEANER_PERIOD
|
Duration |
PT1S
|
quarkus.mailer."mailer-name".keep-alive-timeout
Set the keep alive timeout for the SMTP connection. This value determines how long a connection remains unused in the pool before being evicted and closed. A timeout of 0 means there is no timeout.
Environment variable: QUARKUS_MAILER__MAILER_NAME__KEEP_ALIVE_TIMEOUT
|
Duration |
PT300S
|
quarkus.mailer."mailer-name".ntlm.workstation
Sets the workstation used on NTLM authentication.
Environment variable: QUARKUS_MAILER__MAILER_NAME__NTLM_WORKSTATION
|
string |
|
quarkus.mailer."mailer-name".ntlm.domain
Sets the domain used on NTLM authentication.
Environment variable: QUARKUS_MAILER__MAILER_NAME__NTLM_DOMAIN
|
string |
|
quarkus.mailer."mailer-name".approved-recipients
Allows sending emails to these recipients only.
Approved recipients are compiled to a Pattern and must be a valid regular expression. The created Pattern is case-insensitive as emails are case insensitive. Provided patterns are trimmed before being compiled.
Environment variable: QUARKUS_MAILER__MAILER_NAME__APPROVED_RECIPIENTS
|
list of Pattern |
|
quarkus.mailer."mailer-name".log-rejected-recipients
Log rejected recipients as warnings.
If false, the rejected recipients will be logged at the DEBUG level.
Environment variable: QUARKUS_MAILER__MAILER_NAME__LOG_REJECTED_RECIPIENTS
|
boolean |
false
|
Messaging |
Type |
Default |
quarkus.messaging.health.enabled
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_MESSAGING_HEALTH_ENABLED
|
boolean |
true
|
quarkus.messaging.auto-connector-attachment
Whether it should automatically configure the connector attribute of channels that don’t have an upstream source (for incoming channels), or a downstream consumer (for outgoing channels). When enabled, it verifies that there is only a single connector on the classpath. In that case, it automatically associates the orphans channel to the connector, removing the need to add the .connector attribute in the application configuration.
Environment variable: QUARKUS_MESSAGING_AUTO_CONNECTOR_ATTACHMENT
|
boolean |
true
|
quarkus.messaging.metrics.enabled
Whether Reactive Messaging metrics are published in case a metrics extension is present (default to false).
Environment variable: QUARKUS_MESSAGING_METRICS_ENABLED
|
boolean |
false
|
Enables or disables the strict validation mode.
Environment variable: QUARKUS_MESSAGING_STRICT
|
boolean |
false
|
quarkus.messaging.blocking.signatures.execution.mode
Execution mode for the Messaging signatures considered "blocking", defaults to "worker". For the previous behaviour set to "event-loop".
Environment variable: QUARKUS_MESSAGING_BLOCKING_SIGNATURES_EXECUTION_MODE
|
event-loop , worker , virtual-thread
|
worker
|
Configuration for the health center filter |
Type |
Default |
quarkus.messaging.health."channel".enabled
Whether all health check is enabled
Environment variable: QUARKUS_MESSAGING_HEALTH__CHANNEL__ENABLED
|
boolean |
true
|
quarkus.messaging.health."channel".readiness.enabled
Whether the readiness health check is enabled.
Environment variable: QUARKUS_MESSAGING_HEALTH__CHANNEL__READINESS_ENABLED
|
boolean |
true
|
quarkus.messaging.health."channel".liveness.enabled
Whether the liveness health check is enabled.
Environment variable: QUARKUS_MESSAGING_HEALTH__CHANNEL__LIVENESS_ENABLED
|
boolean |
true
|
quarkus.messaging.health."channel".startup.enabled
Whether the startup health check is enabled.
Environment variable: QUARKUS_MESSAGING_HEALTH__CHANNEL__STARTUP_ENABLED
|
boolean |
true
|
Messaging - AMQP 1.0 |
Type |
Default |
Dev Services |
Type |
Default |
quarkus.amqp.devservices.enabled
If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless amqp-host or amqp-port are set or if all the Reactive Messaging AMQP channel are configured with host or port .
Environment variable: QUARKUS_AMQP_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.amqp.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_AMQP_DEVSERVICES_PORT
|
int |
|
quarkus.amqp.devservices.image-name
The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with artemiscloud/activemq-artemis-broker .
Environment variable: QUARKUS_AMQP_DEVSERVICES_IMAGE_NAME
|
string |
quay.io/artemiscloud/activemq-artemis-broker:1.0.25
|
quarkus.amqp.devservices.extra-args
The value of the AMQ_EXTRA_ARGS environment variable to pass to the container. For ActiveMQ Artemis Broker ⇐ 1.0.21, set this property to --no-autotune --mapped --no-fsync --relax-jolokia --http-host 0.0.0.0
Environment variable: QUARKUS_AMQP_DEVSERVICES_EXTRA_ARGS
|
string |
--no-autotune --mapped --no-fsync --relax-jolokia
|
quarkus.amqp.devservices.shared
Indicates if the AMQP broker 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 AMQP starts a new container.
The discovery uses the quarkus-dev-service-amqp label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_AMQP_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.amqp.devservices.service-name
The value of the quarkus-dev-service-aqmp 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 AMQP looks for a container with the quarkus-dev-service-amqp 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-amqp label set to the specified value.
This property is used when you need multiple shared AMQP brokers.
Environment variable: QUARKUS_AMQP_DEVSERVICES_SERVICE_NAME
|
string |
amqp
|
quarkus.amqp.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_AMQP_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Messaging - Kafka |
Type |
Default |
quarkus.messaging.kafka.serializer-autodetection.enabled
Whether or not Kafka serializer/deserializer auto-detection is enabled.
Environment variable: QUARKUS_MESSAGING_KAFKA_SERIALIZER_AUTODETECTION_ENABLED
|
boolean |
true
|
quarkus.messaging.kafka.serializer-generation.enabled
Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde.
Environment variable: QUARKUS_MESSAGING_KAFKA_SERIALIZER_GENERATION_ENABLED
|
boolean |
true
|
quarkus.messaging.kafka.enable-graceful-shutdown-in-dev-and-test-mode
Enables the graceful shutdown in dev and test modes. The graceful shutdown waits until the inflight records have been processed and the offset committed to Kafka. While this setting is highly recommended in production, in dev and test modes, it’s disabled by default. This setting allows to re-enable it.
Environment variable: QUARKUS_MESSAGING_KAFKA_ENABLE_GRACEFUL_SHUTDOWN_IN_DEV_AND_TEST_MODE
|
boolean |
false
|
Messaging - MQTT |
Type |
Default |
quarkus.mqtt.devservices.enabled
If Dev Services for MQTT has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For MQTT, Dev Services starts a broker unless *.host or *.port are set for one of the connectors or if all the Reactive Messaging MQTT channel are configured with host or port .
Environment variable: QUARKUS_MQTT_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.mqtt.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_MQTT_DEVSERVICES_PORT
|
int |
|
quarkus.mqtt.devservices.image-name
Environment variable: QUARKUS_MQTT_DEVSERVICES_IMAGE_NAME
|
string |
eclipse-mosquitto:2.0.15
|
quarkus.mqtt.devservices.shared
Indicates if the MQTT broker 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 MQTT starts a new container.
The discovery uses the quarkus-dev-service-mqtt label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_MQTT_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.mqtt.devservices.service-name
The value of the quarkus-dev-service-mqtt 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 MQTT looks for a container with the quarkus-dev-service-mqtt 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-mqtt label set to the specified value.
This property is used when you need multiple shared MQTT brokers.
Environment variable: QUARKUS_MQTT_DEVSERVICES_SERVICE_NAME
|
string |
mqtt
|
quarkus.mqtt.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_MQTT_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Messaging - Pulsar |
Type |
Default |
quarkus.messaging.pulsar.schema-autodetection.enabled
Whether or not Pulsar Schema auto-detection is enabled.
Environment variable: QUARKUS_MESSAGING_PULSAR_SCHEMA_AUTODETECTION_ENABLED
|
boolean |
true
|
quarkus.messaging.pulsar.schema-generation.enabled
Whether Pulsar Schema generation is enabled. When no Schema are found and not set, Quarkus generates a JSON Schema.
Environment variable: QUARKUS_MESSAGING_PULSAR_SCHEMA_GENERATION_ENABLED
|
boolean |
true
|
Dev Services |
Type |
Default |
quarkus.pulsar.devservices.enabled
If Dev Services for Pulsar has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Pulsar, Dev Services starts a broker unless pulsar.client.serviceUrl is set or if all the Reactive Messaging Pulsar channel are configured with serviceUrl .
Environment variable: QUARKUS_PULSAR_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.pulsar.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_PULSAR_DEVSERVICES_PORT
|
int |
|
quarkus.pulsar.devservices.image-name
The image to use. Note that only Apache Pulsar images are supported. Specifically, the image repository must end with apachepulsar/pulsar . Check https://hub.docker.com/r/apachepulsar/pulsar to find the available versions.
Environment variable: QUARKUS_PULSAR_DEVSERVICES_IMAGE_NAME
|
string |
apachepulsar/pulsar:3.3.0
|
quarkus.pulsar.devservices.shared
Indicates if the Pulsar broker 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 Pulsar starts a new container.
The discovery uses the quarkus-dev-service-pulsar label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_PULSAR_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.pulsar.devservices.service-name
The value of the quarkus-dev-service-pulsar 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 Pulsar looks for a container with the quarkus-dev-service-pulsar 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-pulsar label set to the specified value.
This property is used when you need multiple shared Pulsar brokers.
Environment variable: QUARKUS_PULSAR_DEVSERVICES_SERVICE_NAME
|
string |
pulsar
|
quarkus.pulsar.devservices.broker-config."environment-variable-name"
Broker config to set on the Pulsar instance
Environment variable: QUARKUS_PULSAR_DEVSERVICES_BROKER_CONFIG__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Messaging - RabbitMQ 1.0 |
Type |
Default |
Dev Services |
Type |
Default |
quarkus.rabbitmq.devservices.enabled
If Dev Services for RabbitMQ has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For RabbitMQ, Dev Services starts a broker unless rabbitmq-host or rabbitmq-port are set or if all the Reactive Messaging RabbitMQ channel are configured with host or port .
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.rabbitmq.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_PORT
|
int |
|
quarkus.rabbitmq.devservices.http-port
Optional fixed port for the RabbitMQ management plugin.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_HTTP_PORT
|
int |
|
quarkus.rabbitmq.devservices.image-name
The image to use. Note that only official RabbitMQ images are supported. Specifically, the image repository must end with rabbitmq .
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_IMAGE_NAME
|
string |
rabbitmq:3.12-management
|
quarkus.rabbitmq.devservices.shared
Indicates if the RabbitMQ broker 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 RabbitMQ starts a new container.
The discovery uses the quarkus-dev-service-rabbitmq label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.rabbitmq.devservices.service-name
The value of the quarkus-dev-service-rabbitmq 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 RabbitMQ looks for a container with the quarkus-dev-service-rabbitmq 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-rabbitmq label set to the specified value.
This property is used when you need multiple shared RabbitMQ brokers.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_SERVICE_NAME
|
string |
rabbitmq
|
quarkus.rabbitmq.devservices.exchanges."exchange-name".type
Type of exchange: direct, topic, headers, fanout, etc.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__TYPE
|
string |
direct
|
quarkus.rabbitmq.devservices.exchanges."exchange-name".auto-delete
Should the exchange be deleted when all queues are finished using it?
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__AUTO_DELETE
|
boolean |
false
|
quarkus.rabbitmq.devservices.exchanges."exchange-name".durable
Should the exchange remain after restarts?
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__DURABLE
|
boolean |
false
|
quarkus.rabbitmq.devservices.exchanges."exchange-name".arguments."argument-name"
Extra arguments for the exchange definition.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_EXCHANGES__EXCHANGE_NAME__ARGUMENTS__ARGUMENT_NAME_
|
Map<String,String> |
|
quarkus.rabbitmq.devservices.queues."queue-name".auto-delete
Should the queue be deleted when all consumers are finished using it?
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__AUTO_DELETE
|
boolean |
false
|
quarkus.rabbitmq.devservices.queues."queue-name".durable
Should the queue remain after restarts?
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__DURABLE
|
boolean |
false
|
quarkus.rabbitmq.devservices.queues."queue-name".arguments."argument-name"
Extra arguments for the queue definition.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_QUEUES__QUEUE_NAME__ARGUMENTS__ARGUMENT_NAME_
|
Map<String,String> |
|
quarkus.rabbitmq.devservices.bindings."binding-name".source
Source exchange to bind to. Defaults to name of binding instance.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__SOURCE
|
string |
|
quarkus.rabbitmq.devservices.bindings."binding-name".routing-key
Routing key specification for the source exchange.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__ROUTING_KEY
|
string |
#
|
quarkus.rabbitmq.devservices.bindings."binding-name".destination
Destination exchange or queue to bind to. Defaults to name of binding instance.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__DESTINATION
|
string |
|
quarkus.rabbitmq.devservices.bindings."binding-name".destination-type
Destination type for binding: queue, exchange, etc.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__DESTINATION_TYPE
|
string |
queue
|
quarkus.rabbitmq.devservices.bindings."binding-name".arguments."argument-name"
Extra arguments for the binding definition.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_BINDINGS__BINDING_NAME__ARGUMENTS__ARGUMENT_NAME_
|
Map<String,String> |
|
quarkus.rabbitmq.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_RABBITMQ_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.rabbitmq.credentials-provider
The credentials provider name.
Environment variable: QUARKUS_RABBITMQ_CREDENTIALS_PROVIDER
|
string |
|
quarkus.rabbitmq.credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_RABBITMQ_CREDENTIALS_PROVIDER_NAME
|
string |
|
Micrometer metrics |
Type |
Default |
quarkus.micrometer.enabled
Micrometer metrics support.
Micrometer metrics support is enabled by default.
Environment variable: QUARKUS_MICROMETER_ENABLED
|
boolean |
true
|
quarkus.micrometer.registry-enabled-default
Micrometer MeterRegistry discovery.
Micrometer MeterRegistry implementations discovered on the classpath will be enabled automatically by default.
Environment variable: QUARKUS_MICROMETER_REGISTRY_ENABLED_DEFAULT
|
boolean |
true
|
quarkus.micrometer.binder-enabled-default
Micrometer MeterBinder discovery.
Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default.
Environment variable: QUARKUS_MICROMETER_BINDER_ENABLED_DEFAULT
|
boolean |
true
|
quarkus.micrometer.binder.http-client.enabled
Outbound HTTP request metrics support.
Support for HTTP client metrics will be enabled if Micrometer support is enabled, the REST client feature is enabled, and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_ENABLED
|
boolean |
|
quarkus.micrometer.binder.http-server.enabled
Inbound HTTP metrics support.
Support for HTTP server metrics will be enabled if Micrometer support is enabled, an extension serving HTTP traffic is enabled, and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_SERVER_ENABLED
|
boolean |
|
quarkus.micrometer.binder.jvm
Micrometer JVM metrics support.
Support for JVM metrics will be enabled if Micrometer support is enabled, and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_JVM
|
boolean |
|
quarkus.micrometer.binder.kafka.enabled
Support for Kafka metrics will be enabled if Micrometer support is enabled, the Kafka Consumer or Producer interface is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_KAFKA_ENABLED
|
boolean |
|
quarkus.micrometer.binder.redis.enabled
Redis client metrics support.
Support for Redis metrics will be enabled if Micrometer support is enabled, the Quarkus Redis client extension is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_REDIS_ENABLED
|
boolean |
|
quarkus.micrometer.binder.stork.enabled
Support for Stork metrics will be enabled if Micrometer support is enabled, the Quarkus Stork extension is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_STORK_ENABLED
|
boolean |
|
quarkus.micrometer.binder.grpc-server.enabled
gRPC Server metrics support.
Support for gRPC server metrics will be enabled if Micrometer support is enabled, the gRPC server interfaces are on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_GRPC_SERVER_ENABLED
|
boolean |
|
quarkus.micrometer.binder.grpc-client.enabled
gRPC Client metrics support.
Support for gRPC client metrics will be enabled if Micrometer support is enabled, the gRPC client interfaces are on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_GRPC_CLIENT_ENABLED
|
boolean |
|
quarkus.micrometer.binder.messaging.enabled
Support for Reactive Messaging metrics will be enabled if Micrometer support is enabled, MessageObservationCollector interface is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_MESSAGING_ENABLED
|
boolean |
|
quarkus.micrometer.binder.mp-metrics.enabled
Eclipse MicroProfile Metrics support.
Support for MicroProfile Metrics will be enabled if Micrometer
support is enabled and the MicroProfile Metrics dependency is present:
<dependency>
<groupId>org.eclipse.microprofile.metrics</groupId>
<artifactId>microprofile-metrics-api</artifactId>
</dependency>
The Micrometer extension currently provides a compatibility layer that supports the MP Metrics API,
but metric names and recorded values will be different.
Note that the MP Metrics compatibility layer will move to a different extension in the future.
Environment variable: QUARKUS_MICROMETER_BINDER_MP_METRICS_ENABLED
|
boolean |
|
quarkus.micrometer.binder.system
Micrometer System metrics support.
Support for System metrics will be enabled if Micrometer support is enabled, and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_SYSTEM
|
boolean |
|
quarkus.micrometer.binder.vertx.enabled
Support for Vert.x metrics will be enabled if Micrometer support is enabled, Vert.x MetricsOptions is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_VERTX_ENABLED
|
boolean |
|
quarkus.micrometer.binder.netty.enabled
Support for Netty metrics will be enabled if Micrometer support is enabled, the Netty allocator classes are on the classpath and either this value is true, or this value is unset and quarkus.micrometer.binder-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_BINDER_NETTY_ENABLED
|
boolean |
|
quarkus.micrometer.export.json.enabled
Support for export to JSON format. Off by default.
Environment variable: QUARKUS_MICROMETER_EXPORT_JSON_ENABLED
|
boolean |
false
|
quarkus.micrometer.export.json.path
The path for the JSON metrics endpoint. The default value is metrics . By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path} . If the management interface is enabled, the value will be resolved as a path relative to ${quarkus.management.root-path} .
Environment variable: QUARKUS_MICROMETER_EXPORT_JSON_PATH
|
string |
metrics
|
quarkus.micrometer.export.json.buffer-length
Statistics like max, percentiles, and histogram counts decay over time to give greater weight to recent samples. Samples are accumulated to such statistics in ring buffers which rotate after the expiry, with this buffer length.
Environment variable: QUARKUS_MICROMETER_EXPORT_JSON_BUFFER_LENGTH
|
int |
3
|
quarkus.micrometer.export.json.expiry
Statistics like max, percentiles, and histogram counts decay over time to give greater weight to recent samples. Samples are accumulated to such statistics in ring buffers which rotate after this expiry, with a particular buffer length.
Environment variable: QUARKUS_MICROMETER_EXPORT_JSON_EXPIRY
|
Duration |
P3D
|
quarkus.micrometer.export.prometheus.enabled
Support for export to Prometheus.
Support for Prometheus will be enabled if Micrometer support is enabled, the PrometheusMeterRegistry is on the classpath and either this value is true, or this value is unset and quarkus.micrometer.registry-enabled-default is true.
Environment variable: QUARKUS_MICROMETER_EXPORT_PROMETHEUS_ENABLED
|
boolean |
|
quarkus.micrometer.export.prometheus.path
The path for the prometheus metrics endpoint (produces text/plain). The default value is
metrics and is resolved relative to the non-application endpoint (q ), e.g.
${quarkus.http.root-path}/${quarkus.http.non-application-root-path}/metrics .
If an absolute path is specified (/metrics ), the prometheus endpoint will be served
from the configured path.
Environment variable: QUARKUS_MICROMETER_EXPORT_PROMETHEUS_PATH
|
string |
metrics
|
quarkus.micrometer.export.prometheus.default-registry
By default, this extension will create a Prometheus MeterRegistry instance.
Use this attribute to veto the creation of the default Prometheus MeterRegistry.
Environment variable: QUARKUS_MICROMETER_EXPORT_PROMETHEUS_DEFAULT_REGISTRY
|
boolean |
true
|
quarkus.micrometer.binder.http-server.match-patterns
Comma-separated list of regular expressions used to specify uri
labels in http metrics.
Vertx instrumentation will attempt to transform parameterized
resource paths, /item/123 , into a generic form, /item/{id} ,
to reduce the cardinality of uri label values.
Patterns specified here will take precedence over those computed
values.
For example, if /item/\\\\d+=/item/custom or
/item/[0-9]+=/item/custom is specified in this list,
a request to a matching path (/item/123 ) will use the specified
replacement value (/item/custom ) as the value for the uri label.
Note that backslashes must be double escaped as \\\\ .
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_SERVER_MATCH_PATTERNS
|
list of string |
|
quarkus.micrometer.binder.http-server.ignore-patterns
Comma-separated list of regular expressions defining uri paths that should be ignored (not measured).
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_SERVER_IGNORE_PATTERNS
|
list of string |
|
quarkus.micrometer.binder.http-server.suppress-non-application-uris
Suppress non-application uris from metrics collection.
This will suppress all metrics for non-application endpoints using
${quarkus.http.root-path}/${quarkus.http.non-application-root-path} .
Suppressing non-application uris is enabled by default.
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_SERVER_SUPPRESS_NON_APPLICATION_URIS
|
boolean |
true
|
quarkus.micrometer.binder.http-server.max-uri-tags
Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter.
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_SERVER_MAX_URI_TAGS
|
int |
100
|
quarkus.micrometer.export.prometheus."configuration-property-name"
Prometheus registry configuration properties.
Environment variable: QUARKUS_MICROMETER_EXPORT_PROMETHEUS__CONFIGURATION_PROPERTY_NAME_
|
Map<String,String> |
|
quarkus.micrometer.binder.http-client.match-patterns
Comma-separated list of regular expressions used to specify uri
labels in http metrics.
Outbount HTTP client instrumentation will attempt to transform parameterized
resource paths, /item/123 , into a generic form, /item/{id} ,
to reduce the cardinality of uri label values.
Patterns specified here will take precedence over those computed
values.
For example, if /item/\\\\d+=/item/custom or
/item/[0-9]+=/item/custom is specified in this list,
a request to a matching path (/item/123 ) will use the specified
replacement value (/item/custom ) as the value for the uri label.
Note that backslashes must be double escaped as \\\\ .
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_MATCH_PATTERNS
|
list of string |
|
quarkus.micrometer.binder.http-client.ignore-patterns
Comma-separated list of regular expressions defining uri paths that should be ignored (not measured).
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_IGNORE_PATTERNS
|
list of string |
|
quarkus.micrometer.binder.http-client.max-uri-tags
Maximum number of unique URI tag values allowed. After the max number of tag values is reached, metrics with additional tag values are denied by filter.
Environment variable: QUARKUS_MICROMETER_BINDER_HTTP_CLIENT_MAX_URI_TAGS
|
int |
100
|
MongoDB Client |
Type |
Default |
quarkus.mongodb.health.enabled
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_MONGODB_HEALTH_ENABLED
|
boolean |
true
|
quarkus.mongodb.metrics.enabled
Whether metrics are published in case a metrics extension is present.
Environment variable: QUARKUS_MONGODB_METRICS_ENABLED
|
boolean |
false
|
quarkus.mongodb.force-default-clients
If set to true, the default clients will always be created even if there are no injection points that use them
Environment variable: QUARKUS_MONGODB_FORCE_DEFAULT_CLIENTS
|
boolean |
false
|
quarkus.mongodb.tracing.enabled
Whether or not tracing spans of driver commands are sent in case the quarkus-opentelemetry extension is present.
Environment variable: QUARKUS_MONGODB_TRACING_ENABLED
|
boolean |
false
|
quarkus.mongodb.connection-string
Configures the connection string. The format is: mongodb://[username:password@]host1[:port1][,host2[:port2],…[,hostN[:portN]]][/[database.collection][?options]]
mongodb:// is a required prefix to identify that this is a string in the standard connection format.
username:password@ are optional. If given, the driver will attempt to log in to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well.
host1 is the only required part of the connection string. It identifies a server address to connect to.
:portX is optional and defaults to :27017 if not provided.
/database is the name of the database to log in to and thus is only relevant if the username:password@ syntax is used. If not specified the admin database will be used by default.
?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&".
An alternative format, using the mongodb+srv protocol, is:
mongodb+srv://[username:password@]host[/[database][?options]]
-
mongodb+srv:// is a required prefix for this format.
-
username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well
-
host is the only required part of the URI. It identifies a single host name for which SRV records are looked up from a Domain Name Server after prefixing the host name with "_mongodb._tcp" . The host/port for each SRV record becomes the seed list used to connect, as if each one were provided as host/port pair in a URI using the normal mongodb protocol.
-
/database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default.
-
?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". Additionally with the mongodb+srv protocol, TXT records are looked up from a Domain Name Server for the given host, and the text value of each one is prepended to any options on the URI itself. Because the last specified value for any option wins, that means that options provided on the URI will override any that are provided via TXT records.
Environment variable: QUARKUS_MONGODB_CONNECTION_STRING
|
string |
|
Configures the MongoDB server addressed (one if single mode). The addresses are passed as host:port .
Environment variable: QUARKUS_MONGODB_HOSTS
|
list of string |
127.0.0.1:27017
|
Configure the database name.
Environment variable: QUARKUS_MONGODB_DATABASE
|
string |
|
quarkus.mongodb.application-name
Configures the application name.
Environment variable: QUARKUS_MONGODB_APPLICATION_NAME
|
string |
|
quarkus.mongodb.max-pool-size
Configures the maximum number of connections in the connection pool.
Environment variable: QUARKUS_MONGODB_MAX_POOL_SIZE
|
int |
|
quarkus.mongodb.min-pool-size
Configures the minimum number of connections in the connection pool.
Environment variable: QUARKUS_MONGODB_MIN_POOL_SIZE
|
int |
|
quarkus.mongodb.max-connection-idle-time
Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed.
Environment variable: QUARKUS_MONGODB_MAX_CONNECTION_IDLE_TIME
|
Duration |
|
quarkus.mongodb.max-connection-life-time
Maximum lifetime of a pooled connection. A connection that exceeds this limit will be closed.
Environment variable: QUARKUS_MONGODB_MAX_CONNECTION_LIFE_TIME
|
Duration |
|
quarkus.mongodb.maintenance-frequency
Configures the time period between runs of the maintenance job.
Environment variable: QUARKUS_MONGODB_MAINTENANCE_FREQUENCY
|
Duration |
|
quarkus.mongodb.maintenance-initial-delay
Configures period of time to wait before running the first maintenance job on the connection pool.
Environment variable: QUARKUS_MONGODB_MAINTENANCE_INITIAL_DELAY
|
Duration |
|
quarkus.mongodb.connect-timeout
How long a connection can take to be opened before timing out.
Environment variable: QUARKUS_MONGODB_CONNECT_TIMEOUT
|
Duration |
|
quarkus.mongodb.read-timeout
How long a socket read can take before timing out.
Environment variable: QUARKUS_MONGODB_READ_TIMEOUT
|
Duration |
|
quarkus.mongodb.tls-insecure
If connecting with TLS, this option enables insecure TLS connections.
Environment variable: QUARKUS_MONGODB_TLS_INSECURE
|
boolean |
false
|
Whether to connect using TLS.
Environment variable: QUARKUS_MONGODB_TLS
|
boolean |
false
|
quarkus.mongodb.replica-set-name
Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set.
Environment variable: QUARKUS_MONGODB_REPLICA_SET_NAME
|
string |
|
quarkus.mongodb.server-selection-timeout
How long the driver will wait for server selection to succeed before throwing an exception.
Environment variable: QUARKUS_MONGODB_SERVER_SELECTION_TIMEOUT
|
Duration |
|
quarkus.mongodb.local-threshold
When choosing among multiple MongoDB servers to send a request, the driver will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the local threshold.
Environment variable: QUARKUS_MONGODB_LOCAL_THRESHOLD
|
Duration |
|
quarkus.mongodb.heartbeat-frequency
The frequency that the driver will attempt to determine the current state of each server in the cluster.
Environment variable: QUARKUS_MONGODB_HEARTBEAT_FREQUENCY
|
Duration |
|
quarkus.mongodb.read-concern
Configures the read concern. Supported values are: local|majority|linearizable|snapshot|available
Environment variable: QUARKUS_MONGODB_READ_CONCERN
|
string |
|
quarkus.mongodb.read-preference
Configures the read preference. Supported values are: primary|primaryPreferred|secondary|secondaryPreferred|nearest
Environment variable: QUARKUS_MONGODB_READ_PREFERENCE
|
string |
|
quarkus.mongodb.health.database
The database used during the readiness health checks
Environment variable: QUARKUS_MONGODB_HEALTH_DATABASE
|
string |
admin
|
quarkus.mongodb.uuid-representation
Configures the UUID representation to use when encoding instances of java.util.UUID and when decoding BSON binary values with subtype of 3.
Environment variable: QUARKUS_MONGODB_UUID_REPRESENTATION
|
unspecified , standard , c-sharp-legacy , java-legacy , python-legacy
|
|
quarkus.mongodb.dns.server-host
This property configures the DNS server. If the server is not set, it tries to read the first nameserver from /etc /resolv.conf (if the file exists), otherwise fallback to the default.
Environment variable: QUARKUS_MONGODB_DNS_SERVER_HOST
|
string |
|
quarkus.mongodb.dns.server-port
This property configures the DNS server port.
Environment variable: QUARKUS_MONGODB_DNS_SERVER_PORT
|
int |
53
|
quarkus.mongodb.dns.lookup-timeout
If native.dns.use-vertx-dns-resolver is set to true , this property configures the DNS lookup timeout duration.
Environment variable: QUARKUS_MONGODB_DNS_LOOKUP_TIMEOUT
|
Duration |
5S
|
quarkus.mongodb.dns.log-activity
This property enables the logging ot the DNS lookup. It can be useful to understand why the lookup fails.
Environment variable: QUARKUS_MONGODB_DNS_LOG_ACTIVITY
|
boolean |
false
|
quarkus.mongodb."mongo-client-configs".connection-string
Configures the connection string. The format is: mongodb://[username:password@]host1[:port1][,host2[:port2],…[,hostN[:portN]]][/[database.collection][?options]]
mongodb:// is a required prefix to identify that this is a string in the standard connection format.
username:password@ are optional. If given, the driver will attempt to log in to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well.
host1 is the only required part of the connection string. It identifies a server address to connect to.
:portX is optional and defaults to :27017 if not provided.
/database is the name of the database to log in to and thus is only relevant if the username:password@ syntax is used. If not specified the admin database will be used by default.
?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&".
An alternative format, using the mongodb+srv protocol, is:
mongodb+srv://[username:password@]host[/[database][?options]]
-
mongodb+srv:// is a required prefix for this format.
-
username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well
-
host is the only required part of the URI. It identifies a single host name for which SRV records are looked up from a Domain Name Server after prefixing the host name with "_mongodb._tcp" . The host/port for each SRV record becomes the seed list used to connect, as if each one were provided as host/port pair in a URI using the normal mongodb protocol.
-
/database is the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default.
-
?options are connection options. Note that if database is absent there is still a / required between the last host and the ? introducing the options. Options are name=value pairs and the pairs are separated by "&". Additionally with the mongodb+srv protocol, TXT records are looked up from a Domain Name Server for the given host, and the text value of each one is prepended to any options on the URI itself. Because the last specified value for any option wins, that means that options provided on the URI will override any that are provided via TXT records.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CONNECTION_STRING
|
string |
|
quarkus.mongodb."mongo-client-configs".hosts
Configures the MongoDB server addressed (one if single mode). The addresses are passed as host:port .
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HOSTS
|
list of string |
127.0.0.1:27017
|
quarkus.mongodb."mongo-client-configs".database
Configure the database name.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__DATABASE
|
string |
|
quarkus.mongodb."mongo-client-configs".application-name
Configures the application name.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__APPLICATION_NAME
|
string |
|
quarkus.mongodb."mongo-client-configs".max-pool-size
Configures the maximum number of connections in the connection pool.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_POOL_SIZE
|
int |
|
quarkus.mongodb."mongo-client-configs".min-pool-size
Configures the minimum number of connections in the connection pool.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MIN_POOL_SIZE
|
int |
|
quarkus.mongodb."mongo-client-configs".max-connection-idle-time
Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_IDLE_TIME
|
Duration |
|
quarkus.mongodb."mongo-client-configs".max-connection-life-time
Maximum lifetime of a pooled connection. A connection that exceeds this limit will be closed.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAX_CONNECTION_LIFE_TIME
|
Duration |
|
quarkus.mongodb."mongo-client-configs".maintenance-frequency
Configures the time period between runs of the maintenance job.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_FREQUENCY
|
Duration |
|
quarkus.mongodb."mongo-client-configs".maintenance-initial-delay
Configures period of time to wait before running the first maintenance job on the connection pool.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__MAINTENANCE_INITIAL_DELAY
|
Duration |
|
quarkus.mongodb."mongo-client-configs".connect-timeout
How long a connection can take to be opened before timing out.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CONNECT_TIMEOUT
|
Duration |
|
quarkus.mongodb."mongo-client-configs".read-timeout
How long a socket read can take before timing out.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_TIMEOUT
|
Duration |
|
quarkus.mongodb."mongo-client-configs".tls-insecure
If connecting with TLS, this option enables insecure TLS connections.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__TLS_INSECURE
|
boolean |
false
|
quarkus.mongodb."mongo-client-configs".tls
Whether to connect using TLS.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__TLS
|
boolean |
false
|
quarkus.mongodb."mongo-client-configs".replica-set-name
Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__REPLICA_SET_NAME
|
string |
|
quarkus.mongodb."mongo-client-configs".server-selection-timeout
How long the driver will wait for server selection to succeed before throwing an exception.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__SERVER_SELECTION_TIMEOUT
|
Duration |
|
quarkus.mongodb."mongo-client-configs".local-threshold
When choosing among multiple MongoDB servers to send a request, the driver will only send that request to a server whose ping time is less than or equal to the server with the fastest ping time plus the local threshold.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__LOCAL_THRESHOLD
|
Duration |
|
quarkus.mongodb."mongo-client-configs".heartbeat-frequency
The frequency that the driver will attempt to determine the current state of each server in the cluster.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HEARTBEAT_FREQUENCY
|
Duration |
|
quarkus.mongodb."mongo-client-configs".read-concern
Configures the read concern. Supported values are: local|majority|linearizable|snapshot|available
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_CONCERN
|
string |
|
quarkus.mongodb."mongo-client-configs".read-preference
Configures the read preference. Supported values are: primary|primaryPreferred|secondary|secondaryPreferred|nearest
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__READ_PREFERENCE
|
string |
|
quarkus.mongodb."mongo-client-configs".health.database
The database used during the readiness health checks
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__HEALTH_DATABASE
|
string |
admin
|
quarkus.mongodb."mongo-client-configs".uuid-representation
Configures the UUID representation to use when encoding instances of java.util.UUID and when decoding BSON binary values with subtype of 3.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__UUID_REPRESENTATION
|
unspecified , standard , c-sharp-legacy , java-legacy , python-legacy
|
|
Dev Services |
Type |
Default |
quarkus.mongodb.devservices.enabled
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.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.mongodb.devservices.image-name
The container image name to use, for container based DevServices providers.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.mongodb.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_PORT
|
int |
|
quarkus.mongodb.devservices.properties."property-key"
Generic properties that are added to the connection URL.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.mongodb.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
quarkus.mongodb.devservices.shared
Indicates if the MongoDB 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 MongoDB starts a new container.
The discovery uses the quarkus-dev-service-mongodb label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.mongodb.devservices.service-name
The value of the quarkus-dev-service-mongodb 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 MongoDB looks for a container with the quarkus-dev-service-mongodb 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-mongodb label set to the specified value.
Environment variable: QUARKUS_MONGODB_DEVSERVICES_SERVICE_NAME
|
string |
mongodb
|
Write concern |
Type |
Default |
quarkus.mongodb.write-concern.safe
Configures the safety. If set to true : the driver ensures that all writes are acknowledged by the MongoDB server, or else throws an exception. (see also w and wtimeoutMS ). If set fo
- false : the driver does not ensure that all writes are acknowledged by the MongoDB server.
Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_SAFE
|
boolean |
true
|
quarkus.mongodb.write-concern.journal
Configures the journal writing aspect. If set to true : the driver waits for the server to group commit to the journal file on disk. If set to false : the driver does not wait for the server to group commit to the journal file on disk.
Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_JOURNAL
|
boolean |
true
|
quarkus.mongodb.write-concern.w
When set, the driver adds w: wValue to all write commands. It requires safe to be true . The value is typically a number, but can also be the majority string.
Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_W
|
string |
|
quarkus.mongodb.write-concern.retry-writes
If set to true , the driver will retry supported write operations if they fail due to a network error.
Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_RETRY_WRITES
|
boolean |
false
|
quarkus.mongodb.write-concern.w-timeout
When set, the driver adds wtimeout : ms to all write commands. It requires safe to be true .
Environment variable: QUARKUS_MONGODB_WRITE_CONCERN_W_TIMEOUT
|
Duration |
|
Credentials and authentication mechanism |
Type |
Default |
quarkus.mongodb.credentials.username
Environment variable: QUARKUS_MONGODB_CREDENTIALS_USERNAME
|
string |
|
quarkus.mongodb.credentials.password
Environment variable: QUARKUS_MONGODB_CREDENTIALS_PASSWORD
|
string |
|
quarkus.mongodb.credentials.auth-mechanism
Configures the authentication mechanism to use if a credential was supplied. The default is unspecified, in which case the client will pick the most secure mechanism available based on the sever version. For the GSSAPI and MONGODB-X509 mechanisms, no password is accepted, only the username. Supported values: null or GSSAPI|PLAIN|MONGODB-X509|SCRAM_SHA_1|SCRAM_SHA_256|MONGODB_AWS
Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_MECHANISM
|
string |
|
quarkus.mongodb.credentials.auth-source
Configures the source of the authentication credentials. This is typically the database where the credentials have been created. The value defaults to the database specified in the path portion of the connection string or in the 'database' configuration property. If the database is specified in neither place, the default value is admin . This option is only respected when using the MONGO-CR mechanism (the default).
Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_SOURCE
|
string |
|
quarkus.mongodb.credentials.auth-mechanism-properties."property-key"
Allows passing authentication mechanism properties.
Environment variable: QUARKUS_MONGODB_CREDENTIALS_AUTH_MECHANISM_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.mongodb.credentials.credentials-provider
The credentials provider name
Environment variable: QUARKUS_MONGODB_CREDENTIALS_CREDENTIALS_PROVIDER
|
string |
|
quarkus.mongodb.credentials.credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_MONGODB_CREDENTIALS_CREDENTIALS_PROVIDER_NAME
|
string |
|
Write concern |
Type |
Default |
quarkus.mongodb."mongo-client-configs".write-concern.safe
Configures the safety. If set to true : the driver ensures that all writes are acknowledged by the MongoDB server, or else throws an exception. (see also w and wtimeoutMS ). If set fo
- false : the driver does not ensure that all writes are acknowledged by the MongoDB server.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_SAFE
|
boolean |
true
|
quarkus.mongodb."mongo-client-configs".write-concern.journal
Configures the journal writing aspect. If set to true : the driver waits for the server to group commit to the journal file on disk. If set to false : the driver does not wait for the server to group commit to the journal file on disk.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_JOURNAL
|
boolean |
true
|
quarkus.mongodb."mongo-client-configs".write-concern.w
When set, the driver adds w: wValue to all write commands. It requires safe to be true . The value is typically a number, but can also be the majority string.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_W
|
string |
|
quarkus.mongodb."mongo-client-configs".write-concern.retry-writes
If set to true , the driver will retry supported write operations if they fail due to a network error.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_RETRY_WRITES
|
boolean |
false
|
quarkus.mongodb."mongo-client-configs".write-concern.w-timeout
When set, the driver adds wtimeout : ms to all write commands. It requires safe to be true .
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__WRITE_CONCERN_W_TIMEOUT
|
Duration |
|
Credentials and authentication mechanism |
Type |
Default |
quarkus.mongodb."mongo-client-configs".credentials.username
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_USERNAME
|
string |
|
quarkus.mongodb."mongo-client-configs".credentials.password
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_PASSWORD
|
string |
|
quarkus.mongodb."mongo-client-configs".credentials.auth-mechanism
Configures the authentication mechanism to use if a credential was supplied. The default is unspecified, in which case the client will pick the most secure mechanism available based on the sever version. For the GSSAPI and MONGODB-X509 mechanisms, no password is accepted, only the username. Supported values: null or GSSAPI|PLAIN|MONGODB-X509|SCRAM_SHA_1|SCRAM_SHA_256|MONGODB_AWS
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_AUTH_MECHANISM
|
string |
|
quarkus.mongodb."mongo-client-configs".credentials.auth-source
Configures the source of the authentication credentials. This is typically the database where the credentials have been created. The value defaults to the database specified in the path portion of the connection string or in the 'database' configuration property. If the database is specified in neither place, the default value is admin . This option is only respected when using the MONGO-CR mechanism (the default).
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_AUTH_SOURCE
|
string |
|
quarkus.mongodb."mongo-client-configs".credentials.auth-mechanism-properties."property-key"
Allows passing authentication mechanism properties.
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_AUTH_MECHANISM_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
quarkus.mongodb."mongo-client-configs".credentials.credentials-provider
The credentials provider name
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_CREDENTIALS_PROVIDER
|
string |
|
quarkus.mongodb."mongo-client-configs".credentials.credentials-provider-name
The credentials provider bean name.
This is a bean name (as in @Named ) of a bean that implements CredentialsProvider . It is used to select the credentials provider bean when multiple exist. This is unnecessary when there is only one credentials provider available.
For Vault, the credentials provider bean name is vault-credentials-provider .
Environment variable: QUARKUS_MONGODB__MONGO_CLIENT_CONFIGS__CREDENTIALS_CREDENTIALS_PROVIDER_NAME
|
string |
|
Narayana JTA - Transaction manager |
Type |
Default |
quarkus.transaction-manager.node-name
The node name used by the transaction manager. Must not exceed a length of 28 bytes.
Environment variable: QUARKUS_TRANSACTION_MANAGER_NODE_NAME
|
string |
quarkus
|
quarkus.transaction-manager.shorten-node-name-if-necessary
Whether the node name should be shortened if necessary. The node name must not exceed a length of 28 bytes. If this property is set to true , and the node name exceeds 28 bytes, the node name is shortened by calculating the SHA-224 hash, which has a length of 28 bytes.
Environment variable: QUARKUS_TRANSACTION_MANAGER_SHORTEN_NODE_NAME_IF_NECESSARY
|
boolean |
false
|
quarkus.transaction-manager.default-transaction-timeout
The default transaction timeout.
Environment variable: QUARKUS_TRANSACTION_MANAGER_DEFAULT_TRANSACTION_TIMEOUT
|
Duration |
60S
|
quarkus.transaction-manager.enable-recovery
Start the recovery service on startup.
Environment variable: QUARKUS_TRANSACTION_MANAGER_ENABLE_RECOVERY
|
boolean |
false
|
quarkus.transaction-manager.recovery-modules
The list of recovery modules.
Environment variable: QUARKUS_TRANSACTION_MANAGER_RECOVERY_MODULES
|
list of string |
com.arjuna.ats.internal.arjuna.recovery.AtomicActionRecoveryModule,com.arjuna.ats.internal.jta.recovery.arjunacore.XARecoveryModule
|
quarkus.transaction-manager.expiry-scanners
The list of expiry scanners.
Environment variable: QUARKUS_TRANSACTION_MANAGER_EXPIRY_SCANNERS
|
list of string |
com.arjuna.ats.internal.arjuna.recovery.ExpiredTransactionStatusManagerScanner
|
quarkus.transaction-manager.xa-resource-orphan-filters
The list of orphan filters.
Environment variable: QUARKUS_TRANSACTION_MANAGER_XA_RESOURCE_ORPHAN_FILTERS
|
list of string |
com.arjuna.ats.internal.jta.recovery.arjunacore.JTATransactionLogXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTANodeNameXAResourceOrphanFilter,com.arjuna.ats.internal.jta.recovery.arjunacore.JTAActionStatusServiceXAResourceOrphanFilter
|
quarkus.transaction-manager.object-store.directory
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DIRECTORY
|
string |
ObjectStore
|
quarkus.transaction-manager.object-store.type
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_TYPE
|
|
file-system
|
quarkus.transaction-manager.object-store.datasource
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DATASOURCE
|
string |
|
quarkus.transaction-manager.object-store.create-table
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_CREATE_TABLE
|
boolean |
false
|
quarkus.transaction-manager.object-store.drop-table
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_DROP_TABLE
|
boolean |
false
|
quarkus.transaction-manager.object-store.table-prefix
Environment variable: QUARKUS_TRANSACTION_MANAGER_OBJECT_STORE_TABLE_PREFIX
|
string |
quarkus_
|
Narayana MicroProfile LRA Participant |
Type |
Default |
quarkus.lra.openapi.included
Whether to include LRA proxy endpoints in the generated OpenAPI document
Environment variable: QUARKUS_LRA_OPENAPI_INCLUDED
|
boolean |
false
|
quarkus.lra.coordinator-url
The REST endpoint on which a coordinator is running. In order for an LRA to begin and end successfully and in order to join with an existing LRA, this coordinator must be available whenever a service method annotated with @LRA is invoked. In this version of the extension, a failed coordinator with LRAs that have not yet finished must be restarted.
Environment variable: QUARKUS_LRA_COORDINATOR_URL
|
string |
http://localhost:50000/lra-coordinator
|
Netty |
Type |
Default |
quarkus.netty.allocator-max-order
The value configuring the io.netty.allocator.maxOrder system property of Netty. The default value is 3 . Configuring this property overrides the minimum maxOrder requested by the extensions. This property affects the memory consumption of the application. It must be used carefully. More details on https://programmer.group/pool-area-of-netty-memory-pool.html.
Environment variable: QUARKUS_NETTY_ALLOCATOR_MAX_ORDER
|
int |
|
Observability Dev Services |
Type |
Default |
Grafana LGTM configuration |
Type |
Default |
quarkus.observability.lgtm.enabled
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 containers when running in Dev or Test mode and when Docker is running.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_ENABLED
|
boolean |
true
|
quarkus.observability.lgtm.shared
Indicates if the container 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 starts a new container.
The discovery uses the quarkus-dev-service-label label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_SHARED
|
boolean |
true
|
quarkus.observability.lgtm.service-name
The value of the quarkus-dev-service 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 looks for a container with the quarkus-dev-service 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 label set to the specified value.
This property is used when you need multiple shared containers.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_SERVICE_NAME
|
string |
quarkus
|
quarkus.observability.lgtm.username
Environment variable: QUARKUS_OBSERVABILITY_LGTM_USERNAME
|
string |
admin
|
quarkus.observability.lgtm.password
Environment variable: QUARKUS_OBSERVABILITY_LGTM_PASSWORD
|
string |
admin
|
quarkus.observability.lgtm.grafana-port
The port of the Grafana container.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_GRAFANA_PORT
|
int |
3000
|
quarkus.observability.lgtm.timeout
Environment variable: QUARKUS_OBSERVABILITY_LGTM_TIMEOUT
|
Duration |
PT1M
|
quarkus.observability.lgtm.image-name
The name of the Grafana LGTM Docker image.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_IMAGE_NAME
|
string |
docker.io/grafana/otel-lgtm:0.4.0
|
quarkus.observability.lgtm.network-aliases
The Docker network aliases.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_NETWORK_ALIASES
|
list of string |
lgtm,lgtm.testcontainer.docker
|
quarkus.observability.lgtm.label
The label of the container.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_LABEL
|
string |
quarkus-dev-service-lgtm
|
quarkus.observability.lgtm.otlp-port
The port on which LGTM’s OTLP port will be exposed.
Environment variable: QUARKUS_OBSERVABILITY_LGTM_OTLP_PORT
|
int |
4318
|
quarkus.observability.enabled
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 containers when running in Dev or Test mode and when Docker is running.
Environment variable: QUARKUS_OBSERVABILITY_ENABLED
|
boolean |
true
|
quarkus.observability.dev-resources
Enable simplified usage of dev resources, instead of full observability processing. Make sure @code{enabled} is set to false.
Environment variable: QUARKUS_OBSERVABILITY_DEV_RESOURCES
|
boolean |
false
|
quarkus.observability.parallel
Do we start the dev services in parallel.
Environment variable: QUARKUS_OBSERVABILITY_PARALLEL
|
boolean |
false
|
OpenID Connect Adapter |
Type |
Default |
Dev Services |
Type |
Default |
quarkus.keycloak.devservices.enabled
Flag to enable (default) or disable Dev Services. When enabled, Dev Services for Keycloak automatically configures and starts Keycloak in Dev or Test mode, and when Docker is running.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.keycloak.devservices.image-name
The container image name for Dev Services providers. Defaults to a Quarkus-based Keycloak image. For a WildFly-based distribution, use an image like quay.io/keycloak/keycloak:19.0.3-legacy . Keycloak Quarkus and WildFly images are initialized differently. Dev Services for Keycloak will assume it is a Keycloak Quarkus image unless the image version ends with -legacy . Override with quarkus.keycloak.devservices.keycloak-x-image .
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME
|
string |
quay.io/keycloak/keycloak:25.0.2
|
quarkus.keycloak.devservices.keycloak-x-image
Indicates if a Keycloak-X image is used. By default, the image is identified by keycloak-x in the image name. For custom images, override with quarkus.keycloak.devservices.keycloak-x-image . You do not need to set this property if the default check works.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE
|
boolean |
|
quarkus.keycloak.devservices.shared
Determines if the Keycloak container is shared. When shared, Quarkus uses label-based service discovery to find and reuse a running Keycloak container, so a second one is not started. Otherwise, if a matching container is not is found, a new container is started. The service discovery uses the quarkus-dev-service-label label, whose value is set by the service-name property. Container sharing is available only in dev mode.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.keycloak.devservices.service-name
The value of the quarkus-dev-service-keycloak label for identifying the Keycloak container. Used in shared mode to locate an existing container with this label. If not found, a new container is initialized with this label. Applicable only in dev mode.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME
|
string |
quarkus
|
quarkus.keycloak.devservices.realm-path
A comma-separated list of class or file system paths to Keycloak realm files. This list is used to initialize Keycloak. The first value in this list is used to initialize default tenant connection properties.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH
|
list of string |
|
quarkus.keycloak.devservices.resource-aliases."alias-name"
Aliases to additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between an alias and a class or file system resource path.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_
|
Map<String,String> |
|
quarkus.keycloak.devservices.resource-mappings."resource-name"
Additional class or file system resources that are used to initialize Keycloak. Each map entry represents a mapping between a class or file system resource path alias and the Keycloak container location.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS__RESOURCE_NAME_
|
Map<String,String> |
|
quarkus.keycloak.devservices.java-opts
The JAVA_OPTS passed to the keycloak JVM
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS
|
string |
|
quarkus.keycloak.devservices.show-logs
Show Keycloak log messages with a "Keycloak:" prefix.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS
|
boolean |
false
|
quarkus.keycloak.devservices.start-command
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND
|
string |
|
quarkus.keycloak.devservices.realm-name
The name of the Keycloak realm. This property is used to create the realm if the realm file pointed to by the realm-path property does not exist. The default value is quarkus in this case. It is recommended to always set this property so that Dev Services for Keycloak can identify the realm name without parsing the realm file.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME
|
string |
|
quarkus.keycloak.devservices.create-realm
Specifies whether to create the Keycloak realm when no realm file is found at the realm-path . Set to false if the realm is to be created using either the Keycloak Administration Console or the Keycloak Admin API provided by io.quarkus.test.common.QuarkusTestResourceLifecycleManager .
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM
|
boolean |
true
|
quarkus.keycloak.devservices.users."users"
A map of Keycloak usernames to passwords. If empty, default users alice and bob are created with their names as passwords. This map is used for user creation when no realm file is found at the realm-path .
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_USERS__USERS_
|
Map<String,String> |
|
quarkus.keycloak.devservices.roles."role-name"
A map of roles for Keycloak users. If empty, default roles are assigned: alice receives admin and user roles, while other users receive user role. This map is used for role creation when no realm file is found at the realm-path .
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_ROLES__ROLE_NAME_
|
list of Map<String,List<String>> |
|
quarkus.keycloak.devservices.port
The specific port for the dev service to listen on.
If not specified, a random port is selected.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_PORT
|
int |
|
quarkus.keycloak.devservices.container-env."environment-variable-name"
Environment variables to be passed to the container.
Environment variable: QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
If the OIDC extension is enabled.
Environment variable: QUARKUS_OIDC_ENABLED
|
boolean |
true
|
quarkus.oidc.devui.grant.type
Grant type which will be used to acquire a token to test the OIDC 'service' applications
Environment variable: QUARKUS_OIDC_DEVUI_GRANT_TYPE
|
client , password , code , implicit
|
|
quarkus.oidc.devui.grant-options."option-name"
Environment variable: QUARKUS_OIDC_DEVUI_GRANT_OPTIONS__OPTION_NAME_
|
Map<String,Map<String,String>> |
|
quarkus.oidc.devui.web-client-timeout
The WebClient timeout. Use this property to configure how long an HTTP client used by Dev UI handlers will wait for a response when requesting tokens from OpenId Connect Provider and sending them to the service endpoint. This timeout is also used by the OIDC dev service admin client.
Environment variable: QUARKUS_OIDC_DEVUI_WEB_CLIENT_TIMEOUT
|
Duration |
4S
|
quarkus.oidc.default-token-cache-enabled
Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note: This only enables the default implementation. It requires configuration to be activated. See OidcConfig#tokenCache .
Environment variable: QUARKUS_OIDC_DEFAULT_TOKEN_CACHE_ENABLED
|
boolean |
true
|
quarkus.oidc.auth-server-url
Environment variable: QUARKUS_OIDC_AUTH_SERVER_URL
|
string |
|
quarkus.oidc.discovery-enabled
Environment variable: QUARKUS_OIDC_DISCOVERY_ENABLED
|
boolean |
true
|
Environment variable: QUARKUS_OIDC_TOKEN_PATH
|
string |
|
Environment variable: QUARKUS_OIDC_REVOKE_PATH
|
string |
|
Environment variable: QUARKUS_OIDC_CLIENT_ID
|
string |
|
Environment variable: QUARKUS_OIDC_CLIENT_NAME
|
string |
|
quarkus.oidc.connection-delay
Environment variable: QUARKUS_OIDC_CONNECTION_DELAY
|
Duration |
|
quarkus.oidc.connection-retry-count
Environment variable: QUARKUS_OIDC_CONNECTION_RETRY_COUNT
|
int |
3
|
quarkus.oidc.connection-timeout
Environment variable: QUARKUS_OIDC_CONNECTION_TIMEOUT
|
Duration |
10S
|
quarkus.oidc.use-blocking-dns-lookup
Environment variable: QUARKUS_OIDC_USE_BLOCKING_DNS_LOOKUP
|
boolean |
false
|
quarkus.oidc.max-pool-size
Environment variable: QUARKUS_OIDC_MAX_POOL_SIZE
|
int |
|
Environment variable: QUARKUS_OIDC_CREDENTIALS
|
Credentials |
required |
Environment variable: QUARKUS_OIDC_PROXY
|
Proxy |
required |
Environment variable: QUARKUS_OIDC_TLS
|
Tls |
required |
A unique tenant identifier. It can be set by TenantConfigResolver providers, which resolve the tenant configuration dynamically.
Environment variable: QUARKUS_OIDC_TENANT_ID
|
string |
|
quarkus.oidc.tenant-enabled
If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a TenantConfigResolver that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant.
Environment variable: QUARKUS_OIDC_TENANT_ENABLED
|
boolean |
true
|
quarkus.oidc.application-type
The application type, which can be one of the following ApplicationType values.
Environment variable: QUARKUS_OIDC_APPLICATION_TYPE
|
|
service
|
quarkus.oidc.authorization-path
The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for web-app applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled.
Environment variable: QUARKUS_OIDC_AUTHORIZATION_PATH
|
string |
|
quarkus.oidc.user-info-path
The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for web-app applications if OIDC discovery is disabled and the authentication.user-info-required property is enabled. This property is ignored if OIDC discovery is enabled.
Environment variable: QUARKUS_OIDC_USER_INFO_PATH
|
string |
|
quarkus.oidc.introspection-path
Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC_INTROSPECTION_PATH
|
string |
|
Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC_JWKS_PATH
|
string |
|
quarkus.oidc.end-session-path
Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the web-app applications is required. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC_END_SESSION_PATH
|
string |
|
quarkus.oidc.tenant-paths
The paths which must be secured by this tenant. Tenant with the most specific path wins.
Please see the Configure tenant paths
section of the OIDC multitenancy guide for explanation of allowed path patterns.
Environment variable: QUARKUS_OIDC_TENANT_PATHS
|
list of string |
|
The public key for the local JWT token verification. OIDC server connection is not created when this property is set.
Environment variable: QUARKUS_OIDC_PUBLIC_KEY
|
string |
|
quarkus.oidc.introspection-credentials.name
Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_NAME
|
string |
|
quarkus.oidc.introspection-credentials.secret
Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_SECRET
|
string |
|
quarkus.oidc.introspection-credentials.include-client-id
Include OpenId Connect Client ID configured with quarkus.oidc.client-id .
Environment variable: QUARKUS_OIDC_INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID
|
boolean |
true
|
quarkus.oidc.roles.role-claim-path
A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no groups claim but has the groups set in one or more different claims.
Environment variable: QUARKUS_OIDC_ROLES_ROLE_CLAIM_PATH
|
list of string |
|
quarkus.oidc.roles.role-claim-separator
The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard scope claim can contain a space-separated sequence.
Environment variable: QUARKUS_OIDC_ROLES_ROLE_CLAIM_SEPARATOR
|
string |
|
quarkus.oidc.roles.source
Source of the principal roles.
Environment variable: QUARKUS_OIDC_ROLES_SOURCE
|
idtoken , accesstoken , userinfo
|
|
quarkus.oidc.token.issuer
The expected issuer iss claim value. This property overrides the issuer property, which might be set in OpenId Connect provider’s well-known configuration. If the iss claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to any , but it should be done only when other options (such as configuring the provider to use the fixed iss claim value) are not possible.
Environment variable: QUARKUS_OIDC_TOKEN_ISSUER
|
string |
|
quarkus.oidc.token.audience
The expected audience aud claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of quarkus.oidc.client-id property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to any if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured.
Environment variable: QUARKUS_OIDC_TOKEN_AUDIENCE
|
list of string |
|
quarkus.oidc.token.subject-required
Require that the token includes a sub (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo sub claims must be present and match each other.
Environment variable: QUARKUS_OIDC_TOKEN_SUBJECT_REQUIRED
|
boolean |
false
|
quarkus.oidc.token.required-claims."claim-name"
A map of required claims and their expected values. For example, quarkus.oidc.token.required-claims.org_id = org_xyz would require tokens to have the org_id claim to be present and set to org_xyz . Strings are the only supported types. Use SecurityIdentityAugmentor to verify claims of other types or complex claims.
Environment variable: QUARKUS_OIDC_TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_
|
Map<String,String> |
|
quarkus.oidc.token.token-type
Environment variable: QUARKUS_OIDC_TOKEN_TOKEN_TYPE
|
string |
|
quarkus.oidc.token.lifespan-grace
Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.
Environment variable: QUARKUS_OIDC_TOKEN_LIFESPAN_GRACE
|
int |
|
Token age. It allows for the number of seconds to be specified that must not elapse since the iat (issued at) time. A small leeway to account for clock skew which can be configured with quarkus.oidc.token.lifespan-grace to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (exp ) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an exp claim. However, even if the current logout token is allowed to have no exp claim, the exp claim is still verified if the logout token contains it.
Environment variable: QUARKUS_OIDC_TOKEN_AGE
|
Duration |
|
quarkus.oidc.token.issued-at-required
Require that the token includes a iat (issued at) claim Set this property to false if your JWT token does not contain an iat (issued at) claim. Note that ID token is always required to have an iat claim and therefore this property has no impact on the ID token verification process.
Environment variable: QUARKUS_OIDC_TOKEN_ISSUED_AT_REQUIRED
|
boolean |
true
|
quarkus.oidc.token.principal-claim
Name of the claim which contains a principal name. By default, the upn , preferred_username and sub claims are checked.
Environment variable: QUARKUS_OIDC_TOKEN_PRINCIPAL_CLAIM
|
string |
|
quarkus.oidc.token.refresh-expired
Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the authentication.session-age-extension property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type ApplicationType#WEB_APP }. This property is enabled if quarkus.oidc.token.refresh-token-time-skew is configured, you do not need to enable this property manually in this case.
Environment variable: QUARKUS_OIDC_TOKEN_REFRESH_EXPIRED
|
boolean |
false
|
quarkus.oidc.token.refresh-token-time-skew
The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token’s expiration time, a refresh is going to happen.
Environment variable: QUARKUS_OIDC_TOKEN_REFRESH_TOKEN_TIME_SKEW
|
Duration |
|
quarkus.oidc.token.forced-jwk-refresh-interval
The forced JWK set refresh interval in minutes.
Environment variable: QUARKUS_OIDC_TOKEN_FORCED_JWK_REFRESH_INTERVAL
|
Duration |
10M
|
quarkus.oidc.token.header
Custom HTTP header that contains a bearer token. This option is valid only when the application is of type ApplicationType#SERVICE }.
Environment variable: QUARKUS_OIDC_TOKEN_HEADER
|
string |
|
quarkus.oidc.token.authorization-scheme
HTTP Authorization header scheme.
Environment variable: QUARKUS_OIDC_TOKEN_AUTHORIZATION_SCHEME
|
string |
Bearer
|
quarkus.oidc.token.signature-algorithm
Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.
Environment variable: QUARKUS_OIDC_TOKEN_SIGNATURE_ALGORITHM
|
rs256 , rs384 , rs512 , ps256 , ps384 , ps512 , es256 , es384 , es512 , eddsa
|
|
quarkus.oidc.token.decryption-key-location
Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the private_key_jwt client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens.
Environment variable: QUARKUS_OIDC_TOKEN_DECRYPTION_KEY_LOCATION
|
string |
|
quarkus.oidc.token.allow-jwt-introspection
Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to true by default for backward-compatibility reasons. It is planned that this default value will be changed to false in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.
Environment variable: QUARKUS_OIDC_TOKEN_ALLOW_JWT_INTROSPECTION
|
boolean |
true
|
quarkus.oidc.token.require-jwt-introspection-only
Require that JWT tokens are only introspected remotely.
Environment variable: QUARKUS_OIDC_TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY
|
boolean |
false
|
quarkus.oidc.token.allow-opaque-token-introspection
Allow the remote introspection of the opaque tokens. Set this property to false if only JWT tokens are expected.
Environment variable: QUARKUS_OIDC_TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION
|
boolean |
true
|
quarkus.oidc.token.customizer-name
Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using TenantFeature qualifier when registering custom TokenCustomizer . Use this property only to refer to TokenCustomizer implementations provided by this extension.
Environment variable: QUARKUS_OIDC_TOKEN_CUSTOMIZER_NAME
|
string |
|
quarkus.oidc.token.verify-access-token-with-user-info
Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified.
Environment variable: QUARKUS_OIDC_TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO
|
boolean |
false
|
The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.
Environment variable: QUARKUS_OIDC_LOGOUT_PATH
|
string |
|
quarkus.oidc.logout.post-logout-path
Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.
Environment variable: QUARKUS_OIDC_LOGOUT_POST_LOGOUT_PATH
|
string |
|
quarkus.oidc.logout.post-logout-uri-param
Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.
Environment variable: QUARKUS_OIDC_LOGOUT_POST_LOGOUT_URI_PARAM
|
string |
post_logout_redirect_uri
|
quarkus.oidc.logout.extra-params."query-parameter-name"
Additional properties which is added as the query parameters to the logout redirect URI.
Environment variable: QUARKUS_OIDC_LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc.logout.backchannel.path
The relative path of the Back-Channel Logout endpoint at the application.
Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_PATH
|
string |
|
quarkus.oidc.logout.backchannel.token-cache-size
Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE
|
int |
10
|
quarkus.oidc.logout.backchannel.token-cache-time-to-live
Number of minutes a logout token can be cached for.
Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE
|
Duration |
10M
|
quarkus.oidc.logout.backchannel.clean-up-timer-interval
Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.
Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL
|
Duration |
|
quarkus.oidc.logout.backchannel.logout-token-key
Logout token claim whose value is used as a key for caching the tokens. Only sub (subject) and sid (session id) claims can be used as keys. Set it to sid only if ID tokens issued by the OIDC provider have no sub but have sid claim.
Environment variable: QUARKUS_OIDC_LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY
|
string |
sub
|
quarkus.oidc.logout.frontchannel.path
The relative path of the Front-Channel Logout endpoint at the application.
Environment variable: QUARKUS_OIDC_LOGOUT_FRONTCHANNEL_PATH
|
string |
|
quarkus.oidc.certificate-chain.leaf-certificate-name
Common name of the leaf certificate. It must be set if the trust-store-file does not have this certificate imported.
Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME
|
string |
|
quarkus.oidc.certificate-chain.trust-store-file
Truststore file which keeps thumbprints of the trusted certificates.
Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE
|
path |
|
quarkus.oidc.certificate-chain.trust-store-password
A parameter to specify the password of the truststore file if it is configured with trust-store-file .
Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD
|
string |
|
quarkus.oidc.certificate-chain.trust-store-cert-alias
A parameter to specify the alias of the truststore certificate.
Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS
|
string |
|
quarkus.oidc.certificate-chain.trust-store-file-type
An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_OIDC_CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE
|
string |
|
quarkus.oidc.authentication.response-mode
Authorization code flow response mode.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_RESPONSE_MODE
|
|
query
|
quarkus.oidc.authentication.redirect-path
The relative path for calculating a redirect_uri query parameter. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if the current request URI is https://localhost:8080/service , a redirect_uri parameter is set to https://localhost:8080/ if this property is set to / and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if restorePathAfterRedirect is set to true .
Environment variable: QUARKUS_OIDC_AUTHENTICATION_REDIRECT_PATH
|
string |
|
quarkus.oidc.authentication.restore-path-after-redirect
If this property is set to true , the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if redirectPath property is not set, the original request URI is restored even if this property is disabled.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT
|
boolean |
false
|
quarkus.oidc.authentication.remove-redirect-parameters
Remove the query parameters such as code and state set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS
|
boolean |
true
|
quarkus.oidc.authentication.error-path
Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an error and an optional error_description parameters, instead of the expected authorization code . If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if it is set as /error and the current request URI is https://localhost:8080/callback?error=invalid_scope , a redirect is made to https://localhost:8080/error?error=invalid_scope . If this property is not set, HTTP 401 status is returned in case of the user authentication failure.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_ERROR_PATH
|
string |
|
quarkus.oidc.authentication.session-expired-path
Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.
When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned.
Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_SESSION_EXPIRED_PATH
|
string |
|
quarkus.oidc.authentication.verify-access-token
Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.
ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles.
Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless quarkus.oidc.roles.source property is set to accesstoken which means the authorization decision is based on the roles extracted from the access token.
Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to false if it is not required.
Bearer access token is always verified.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_VERIFY_ACCESS_TOKEN
|
boolean |
true when access token is injected as the JsonWebToken bean, false otherwise
|
quarkus.oidc.authentication.force-redirect-https-scheme
Force https as the redirect_uri parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout post_logout_redirect_uri and the local redirect requests.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME
|
boolean |
false
|
quarkus.oidc.authentication.scopes
Environment variable: QUARKUS_OIDC_AUTHENTICATION_SCOPES
|
list of string |
|
quarkus.oidc.authentication.scope-separator
The separator which is used when more than one scope is configured. A single space is used by default.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_SCOPE_SEPARATOR
|
string |
|
quarkus.oidc.authentication.nonce-required
Require that ID token includes a nonce claim which must match nonce authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting nonce in ID token or if you work with OAuth2 provider such as GitHub which does not issue ID tokens.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_NONCE_REQUIRED
|
boolean |
false
|
quarkus.oidc.authentication.add-openid-scope
Add the openid scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_ADD_OPENID_SCOPE
|
boolean |
true
|
quarkus.oidc.authentication.extra-params."parameter-name"
Additional properties added as query parameters to the authentication redirect URI.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc.authentication.forward-params
Request URL query parameters which, if present, are added to the authentication redirect URI.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_FORWARD_PARAMS
|
list of string |
|
quarkus.oidc.authentication.cookie-force-secure
If enabled the state, session, and post logout cookies have their secure parameter set to true when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_FORCE_SECURE
|
boolean |
false
|
quarkus.oidc.authentication.cookie-suffix
Cookie name suffix. For example, a session cookie name for the default OIDC tenant is q_session but can be changed to q_session_test if this property is set to test .
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_SUFFIX
|
string |
|
quarkus.oidc.authentication.cookie-path
Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The cookie-path-header property, if set, is checked first.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH
|
string |
/
|
quarkus.oidc.authentication.cookie-path-header
Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the cookie-path property is checked.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_PATH_HEADER
|
string |
|
quarkus.oidc.authentication.cookie-domain
Cookie domain parameter value which, if set, is used for the session, state and post logout cookies.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_DOMAIN
|
string |
|
quarkus.oidc.authentication.cookie-same-site
SameSite attribute for the session cookie.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_COOKIE_SAME_SITE
|
|
lax
|
quarkus.oidc.authentication.allow-multiple-code-flows
If a state cookie is present, a state query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the state query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS
|
boolean |
true
|
quarkus.oidc.authentication.fail-on-missing-state-param
Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.
When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter.
Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling java-script-auto-redirect or having the provider redirect to URL configured with redirect-path might be needed to avoid such errors.
However, setting this property to false might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM
|
boolean |
false
|
quarkus.oidc.authentication.user-info-required
If this property is set to true , an OIDC UserInfo endpoint is called.
This property is enabled automatically if quarkus.oidc.roles.source is set to userinfo or quarkus.oidc.token.verify-access-token-with-user-info is set to true or quarkus.oidc.authentication.id-token-required is set to false , the current OIDC tenant must support a UserInfo endpoint in these cases.
It is also enabled automatically if io.quarkus.oidc.UserInfo injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_USER_INFO_REQUIRED
|
boolean |
true when UserInfo bean is injected, false otherwise
|
quarkus.oidc.authentication.session-age-extension
Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the token.refresh-expired property has not been enabled.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_SESSION_AGE_EXTENSION
|
Duration |
5M
|
quarkus.oidc.authentication.state-cookie-age
State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see allow-multiple-code-flows . Keep its age to the reasonable minimum value such as 5 minutes or less.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_STATE_COOKIE_AGE
|
Duration |
5M
|
quarkus.oidc.authentication.java-script-auto-redirect
If this property is set to true , a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS.
If this property is set to false , a status code of 499 is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. X-Requested-With request header with its value set to either JavaScript or XMLHttpRequest is expected by default if this property is enabled. You can register a custom JavaScriptRequestChecker to do a custom JavaScript request check instead.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT
|
boolean |
true
|
quarkus.oidc.authentication.id-token-required
Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_ID_TOKEN_REQUIRED
|
boolean |
true
|
quarkus.oidc.authentication.internal-id-token-lifespan
Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN
|
Duration |
5M
|
quarkus.oidc.authentication.pkce-required
Requires that a Proof Key for Code Exchange (PKCE) is used.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_PKCE_REQUIRED
|
boolean |
false
|
quarkus.oidc.authentication.state-secret
Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.
If this secret is not set, the client secret configured with either quarkus.oidc.credentials.secret or quarkus.oidc.credentials.client-secret.value is checked. Finally, quarkus.oidc.credentials.jwt.secret which can be used for client_jwt_secret authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long.
The secret is auto-generated if it remains uninitialized after checking all of these properties.
Error is reported if the secret length is less than 16 characters.
Environment variable: QUARKUS_OIDC_AUTHENTICATION_STATE_SECRET
|
string |
|
quarkus.oidc.code-grant.extra-params."parameter-name"
Additional parameters, in addition to the required code and redirect-uri parameters, which must be included to complete the authorization code grant request.
Environment variable: QUARKUS_OIDC_CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc.code-grant.headers."header-name"
Custom HTTP headers which must be sent to complete the authorization code grant request.
Environment variable: QUARKUS_OIDC_CODE_GRANT_HEADERS__HEADER_NAME_
|
Map<String,String> |
|
quarkus.oidc.token-state-manager.strategy
Default TokenStateManager strategy.
Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_STRATEGY
|
keep-all-tokens , id-token , id-refresh-tokens
|
keep-all-tokens
|
quarkus.oidc.token-state-manager.split-tokens
Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size
Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_SPLIT_TOKENS
|
boolean |
false
|
quarkus.oidc.token-state-manager.encryption-required
Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.
Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED
|
boolean |
true
|
quarkus.oidc.token-state-manager.encryption-secret
The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when encryption-required property is enabled.
If this secret is not set, the client secret configured with either quarkus.oidc.credentials.secret or quarkus.oidc.credentials.client-secret.value is checked. Finally, quarkus.oidc.credentials.jwt.secret which can be used for client_jwt_secret authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required.
The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters.
Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_SECRET
|
string |
|
quarkus.oidc.token-state-manager.encryption-algorithm
Session cookie key encryption algorithm
Environment variable: QUARKUS_OIDC_TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM
|
|
a256-gcmkw
|
quarkus.oidc.allow-token-introspection-cache
Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.
Environment variable: QUARKUS_OIDC_ALLOW_TOKEN_INTROSPECTION_CACHE
|
boolean |
true
|
quarkus.oidc.allow-user-info-cache
Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.
Environment variable: QUARKUS_OIDC_ALLOW_USER_INFO_CACHE
|
boolean |
true
|
quarkus.oidc.cache-user-info-in-idtoken
Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.
Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the allow-user-info-cache property set to false .
Environment variable: QUARKUS_OIDC_CACHE_USER_INFO_IN_IDTOKEN
|
boolean |
|
quarkus.oidc.jwks.resolve-early
If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.
Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.
Environment variable: QUARKUS_OIDC_JWKS_RESOLVE_EARLY
|
boolean |
true
|
quarkus.oidc.jwks.cache-size
Maximum number of JWK keys that can be cached. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC_JWKS_CACHE_SIZE
|
int |
10
|
quarkus.oidc.jwks.cache-time-to-live
Number of minutes a JWK key can be cached for. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC_JWKS_CACHE_TIME_TO_LIVE
|
Duration |
10M
|
quarkus.oidc.jwks.clean-up-timer-interval
Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC_JWKS_CLEAN_UP_TIMER_INTERVAL
|
Duration |
|
quarkus.oidc.jwks.try-all
In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.
Environment variable: QUARKUS_OIDC_JWKS_TRY_ALL
|
boolean |
false
|
Well known OpenId Connect provider identifier
Environment variable: QUARKUS_OIDC_PROVIDER
|
apple , discord , facebook , github , google , linkedin , mastodon , microsoft , spotify , strava , twitch , twitter , x
|
|
quarkus.oidc.token-cache.max-size
Maximum number of cache entries. Set it to a positive value if the cache has to be enabled.
Environment variable: QUARKUS_OIDC_TOKEN_CACHE_MAX_SIZE
|
int |
0
|
quarkus.oidc.token-cache.time-to-live
Maximum amount of time a given cache entry is valid for.
Environment variable: QUARKUS_OIDC_TOKEN_CACHE_TIME_TO_LIVE
|
Duration |
3M
|
quarkus.oidc.token-cache.clean-up-timer-interval
Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically.
Environment variable: QUARKUS_OIDC_TOKEN_CACHE_CLEAN_UP_TIMER_INTERVAL
|
Duration |
|
quarkus.oidc.resolve-tenants-with-issuer
If OIDC tenants should be resolved using the bearer access token’s issuer (iss ) claim value.
Environment variable: QUARKUS_OIDC_RESOLVE_TENANTS_WITH_ISSUER
|
boolean |
false
|
Additional named tenants |
Type |
Default |
quarkus.oidc."tenant".auth-server-url
Environment variable: QUARKUS_OIDC__TENANT__AUTH_SERVER_URL
|
string |
|
quarkus.oidc."tenant".discovery-enabled
Environment variable: QUARKUS_OIDC__TENANT__DISCOVERY_ENABLED
|
boolean |
true
|
quarkus.oidc."tenant".token-path
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_PATH
|
string |
|
quarkus.oidc."tenant".revoke-path
Environment variable: QUARKUS_OIDC__TENANT__REVOKE_PATH
|
string |
|
quarkus.oidc."tenant".client-id
Environment variable: QUARKUS_OIDC__TENANT__CLIENT_ID
|
string |
|
quarkus.oidc."tenant".client-name
Environment variable: QUARKUS_OIDC__TENANT__CLIENT_NAME
|
string |
|
quarkus.oidc."tenant".connection-delay
Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_DELAY
|
Duration |
|
quarkus.oidc."tenant".connection-retry-count
Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_RETRY_COUNT
|
int |
3
|
quarkus.oidc."tenant".connection-timeout
Environment variable: QUARKUS_OIDC__TENANT__CONNECTION_TIMEOUT
|
Duration |
10S
|
quarkus.oidc."tenant".use-blocking-dns-lookup
Environment variable: QUARKUS_OIDC__TENANT__USE_BLOCKING_DNS_LOOKUP
|
boolean |
false
|
quarkus.oidc."tenant".max-pool-size
Environment variable: QUARKUS_OIDC__TENANT__MAX_POOL_SIZE
|
int |
|
quarkus.oidc."tenant".credentials
Environment variable: QUARKUS_OIDC__TENANT__CREDENTIALS
|
Credentials |
required |
quarkus.oidc."tenant".proxy
Environment variable: QUARKUS_OIDC__TENANT__PROXY
|
Proxy |
required |
quarkus.oidc."tenant".tls
Environment variable: QUARKUS_OIDC__TENANT__TLS
|
Tls |
required |
quarkus.oidc."tenant".tenant-id
A unique tenant identifier. It can be set by TenantConfigResolver providers, which resolve the tenant configuration dynamically.
Environment variable: QUARKUS_OIDC__TENANT__TENANT_ID
|
string |
|
quarkus.oidc."tenant".tenant-enabled
If this tenant configuration is enabled. The default tenant is disabled if it is not configured but a TenantConfigResolver that resolves tenant configurations is registered, or named tenants are configured. In this case, you do not need to disable the default tenant.
Environment variable: QUARKUS_OIDC__TENANT__TENANT_ENABLED
|
boolean |
true
|
quarkus.oidc."tenant".application-type
The application type, which can be one of the following ApplicationType values.
Environment variable: QUARKUS_OIDC__TENANT__APPLICATION_TYPE
|
|
service
|
quarkus.oidc."tenant".authorization-path
The relative path or absolute URL of the OpenID Connect (OIDC) authorization endpoint, which authenticates users. You must set this property for web-app applications if OIDC discovery is disabled. This property is ignored if OIDC discovery is enabled.
Environment variable: QUARKUS_OIDC__TENANT__AUTHORIZATION_PATH
|
string |
|
quarkus.oidc."tenant".user-info-path
The relative path or absolute URL of the OIDC UserInfo endpoint. You must set this property for web-app applications if OIDC discovery is disabled and the authentication.user-info-required property is enabled. This property is ignored if OIDC discovery is enabled.
Environment variable: QUARKUS_OIDC__TENANT__USER_INFO_PATH
|
string |
|
quarkus.oidc."tenant".introspection-path
Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JSON Web Token (JWT) tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens must be verified or 2) JWT tokens must be verified while the cached JWK verification set with no matching JWK is being refreshed. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_PATH
|
string |
|
quarkus.oidc."tenant".jwks-path
Relative path or absolute URL of the OIDC JSON Web Key Set (JWKS) endpoint which returns a JSON Web Key Verification Set. This property should be set if OIDC discovery is disabled and the local JWT verification is required. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_PATH
|
string |
|
quarkus.oidc."tenant".end-session-path
Relative path or absolute URL of the OIDC end_session_endpoint. This property must be set if OIDC discovery is disabled and RP Initiated Logout support for the web-app applications is required. This property is ignored if the discovery is enabled.
Environment variable: QUARKUS_OIDC__TENANT__END_SESSION_PATH
|
string |
|
quarkus.oidc."tenant".tenant-paths
The paths which must be secured by this tenant. Tenant with the most specific path wins.
Please see the Configure tenant paths
section of the OIDC multitenancy guide for explanation of allowed path patterns.
Environment variable: QUARKUS_OIDC__TENANT__TENANT_PATHS
|
list of string |
|
quarkus.oidc."tenant".public-key
The public key for the local JWT token verification. OIDC server connection is not created when this property is set.
Environment variable: QUARKUS_OIDC__TENANT__PUBLIC_KEY
|
string |
|
quarkus.oidc."tenant".introspection-credentials.name
Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_NAME
|
string |
|
quarkus.oidc."tenant".introspection-credentials.secret
Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_SECRET
|
string |
|
quarkus.oidc."tenant".introspection-credentials.include-client-id
Include OpenId Connect Client ID configured with quarkus.oidc.client-id .
Environment variable: QUARKUS_OIDC__TENANT__INTROSPECTION_CREDENTIALS_INCLUDE_CLIENT_ID
|
boolean |
true
|
quarkus.oidc."tenant".roles.role-claim-path
A list of paths to claims containing an array of groups. Each path starts from the top level JWT JSON object and can contain multiple segments. Each segment represents a JSON object name only; for example: "realm/groups". Use double quotes with the namespace-qualified claim names. This property can be used if a token has no groups claim but has the groups set in one or more different claims.
Environment variable: QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_PATH
|
list of string |
|
quarkus.oidc."tenant".roles.role-claim-separator
The separator for splitting strings that contain multiple group values. It is only used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space is used by default because the standard scope claim can contain a space-separated sequence.
Environment variable: QUARKUS_OIDC__TENANT__ROLES_ROLE_CLAIM_SEPARATOR
|
string |
|
quarkus.oidc."tenant".roles.source
Source of the principal roles.
Environment variable: QUARKUS_OIDC__TENANT__ROLES_SOURCE
|
idtoken , accesstoken , userinfo
|
|
quarkus.oidc."tenant".token.issuer
The expected issuer iss claim value. This property overrides the issuer property, which might be set in OpenId Connect provider’s well-known configuration. If the iss claim value varies depending on the host, IP address, or tenant id of the provider, you can skip the issuer verification by setting this property to any , but it should be done only when other options (such as configuring the provider to use the fixed iss claim value) are not possible.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ISSUER
|
string |
|
quarkus.oidc."tenant".token.audience
The expected audience aud claim value, which can be a string or an array of strings. Note the audience claim is verified for ID tokens by default. ID token audience must be equal to the value of quarkus.oidc.client-id property. Use this property to override the expected value if your OpenID Connect provider sets a different audience claim value in ID tokens. Set it to any if your provider does not set ID token audience` claim. Audience verification for access tokens is only done if this property is configured.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AUDIENCE
|
list of string |
|
quarkus.oidc."tenant".token.subject-required
Require that the token includes a sub (subject) claim which is a unique and never reassigned identifier for the current user. Note that if you enable this property and if UserInfo is also required, both the token and UserInfo sub claims must be present and match each other.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_SUBJECT_REQUIRED
|
boolean |
false
|
quarkus.oidc."tenant".token.required-claims."claim-name"
A map of required claims and their expected values. For example, quarkus.oidc.token.required-claims.org_id = org_xyz would require tokens to have the org_id claim to be present and set to org_xyz . Strings are the only supported types. Use SecurityIdentityAugmentor to verify claims of other types or complex claims.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REQUIRED_CLAIMS__CLAIM_NAME_
|
Map<String,String> |
|
quarkus.oidc."tenant".token.token-type
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_TOKEN_TYPE
|
string |
|
quarkus.oidc."tenant".token.lifespan-grace
Life span grace period in seconds. When checking token expiry, current time is allowed to be later than token expiration time by at most the configured number of seconds. When checking token issuance, current time is allowed to be sooner than token issue time by at most the configured number of seconds.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_LIFESPAN_GRACE
|
int |
|
quarkus.oidc."tenant".token.age
Token age. It allows for the number of seconds to be specified that must not elapse since the iat (issued at) time. A small leeway to account for clock skew which can be configured with quarkus.oidc.token.lifespan-grace to verify the token expiry time can also be used to verify the token age property. Note that setting this property does not relax the requirement that Bearer and Code Flow JWT tokens must have a valid (exp ) expiry claim value. The only exception where setting this property relaxes the requirement is when a logout token is sent with a back-channel logout request since the current OpenId Connect Back-Channel specification does not explicitly require the logout tokens to contain an exp claim. However, even if the current logout token is allowed to have no exp claim, the exp claim is still verified if the logout token contains it.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AGE
|
Duration |
|
quarkus.oidc."tenant".token.issued-at-required
Require that the token includes a iat (issued at) claim Set this property to false if your JWT token does not contain an iat (issued at) claim. Note that ID token is always required to have an iat claim and therefore this property has no impact on the ID token verification process.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ISSUED_AT_REQUIRED
|
boolean |
true
|
quarkus.oidc."tenant".token.principal-claim
Name of the claim which contains a principal name. By default, the upn , preferred_username and sub claims are checked.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_PRINCIPAL_CLAIM
|
string |
|
quarkus.oidc."tenant".token.refresh-expired
Refresh expired authorization code flow ID or access tokens. If this property is enabled, a refresh token request is performed if the authorization code ID or access token has expired and, if successful, the local session is updated with the new set of tokens. Otherwise, the local session is invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case, the user might not be challenged again if the OIDC provider session is still active. For this option be effective the authentication.session-age-extension property should also be set to a nonzero value since the refresh token is currently kept in the user session. This option is valid only when the application is of type ApplicationType#WEB_APP }. This property is enabled if quarkus.oidc.token.refresh-token-time-skew is configured, you do not need to enable this property manually in this case.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REFRESH_EXPIRED
|
boolean |
false
|
quarkus.oidc."tenant".token.refresh-token-time-skew
The refresh token time skew, in seconds. If this property is enabled, the configured number of seconds is added to the current time when checking if the authorization code ID or access token should be refreshed. If the sum is greater than the authorization code ID or access token’s expiration time, a refresh is going to happen.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REFRESH_TOKEN_TIME_SKEW
|
Duration |
|
quarkus.oidc."tenant".token.forced-jwk-refresh-interval
The forced JWK set refresh interval in minutes.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_FORCED_JWK_REFRESH_INTERVAL
|
Duration |
10M
|
quarkus.oidc."tenant".token.header
Custom HTTP header that contains a bearer token. This option is valid only when the application is of type ApplicationType#SERVICE }.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_HEADER
|
string |
|
quarkus.oidc."tenant".token.authorization-scheme
HTTP Authorization header scheme.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_AUTHORIZATION_SCHEME
|
string |
Bearer
|
quarkus.oidc."tenant".token.signature-algorithm
Required signature algorithm. OIDC providers support many signature algorithms but if necessary you can restrict Quarkus application to accept tokens signed only using an algorithm configured with this property.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_SIGNATURE_ALGORITHM
|
rs256 , rs384 , rs512 , ps256 , ps384 , ps512 , es256 , es384 , es512 , eddsa
|
|
quarkus.oidc."tenant".token.decryption-key-location
Decryption key location. JWT tokens can be inner-signed and encrypted by OpenId Connect providers. However, it is not always possible to remotely introspect such tokens because the providers might not control the private decryption keys. In such cases set this property to point to the file containing the decryption private key in PEM or JSON Web Key (JWK) format. If this property is not set and the private_key_jwt client authentication method is used, the private key used to sign the client authentication JWT tokens are also used to decrypt the encrypted ID tokens.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_DECRYPTION_KEY_LOCATION
|
string |
|
quarkus.oidc."tenant".token.allow-jwt-introspection
Allow the remote introspection of JWT tokens when no matching JWK key is available. This property is set to true by default for backward-compatibility reasons. It is planned that this default value will be changed to false in an upcoming release. Also note this property is ignored if JWK endpoint URI is not available and introspecting the tokens is the only verification option.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ALLOW_JWT_INTROSPECTION
|
boolean |
true
|
quarkus.oidc."tenant".token.require-jwt-introspection-only
Require that JWT tokens are only introspected remotely.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_REQUIRE_JWT_INTROSPECTION_ONLY
|
boolean |
false
|
quarkus.oidc."tenant".token.allow-opaque-token-introspection
Allow the remote introspection of the opaque tokens. Set this property to false if only JWT tokens are expected.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_ALLOW_OPAQUE_TOKEN_INTROSPECTION
|
boolean |
true
|
quarkus.oidc."tenant".token.customizer-name
Token customizer name. Allows to select a tenant specific token customizer as a named bean. Prefer using TenantFeature qualifier when registering custom TokenCustomizer . Use this property only to refer to TokenCustomizer implementations provided by this extension.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_CUSTOMIZER_NAME
|
string |
|
quarkus.oidc."tenant".token.verify-access-token-with-user-info
Indirectly verify that the opaque (binary) access token is valid by using it to request UserInfo. Opaque access token is considered valid if the provider accepted this token and returned a valid UserInfo. You should only enable this option if the opaque access tokens must be accepted but OpenId Connect provider does not have a token introspection endpoint. This property has no effect when JWT tokens must be verified.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_VERIFY_ACCESS_TOKEN_WITH_USER_INFO
|
boolean |
false
|
quarkus.oidc."tenant".logout.path
The relative path of the logout endpoint at the application. If provided, the application is able to initiate the logout through this endpoint in conformance with the OpenID Connect RP-Initiated Logout specification.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_PATH
|
string |
|
quarkus.oidc."tenant".logout.post-logout-path
Relative path of the application endpoint where the user should be redirected to after logging out from the OpenID Connect Provider. This endpoint URI must be properly registered at the OpenID Connect Provider as a valid redirect URI.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_PATH
|
string |
|
quarkus.oidc."tenant".logout.post-logout-uri-param
Name of the post logout URI parameter which is added as a query parameter to the logout redirect URI.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_POST_LOGOUT_URI_PARAM
|
string |
post_logout_redirect_uri
|
quarkus.oidc."tenant".logout.extra-params."query-parameter-name"
Additional properties which is added as the query parameters to the logout redirect URI.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_EXTRA_PARAMS__QUERY_PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc."tenant".logout.backchannel.path
The relative path of the Back-Channel Logout endpoint at the application.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_PATH
|
string |
|
quarkus.oidc."tenant".logout.backchannel.token-cache-size
Maximum number of logout tokens that can be cached before they are matched against ID tokens stored in session cookies.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_SIZE
|
int |
10
|
quarkus.oidc."tenant".logout.backchannel.token-cache-time-to-live
Number of minutes a logout token can be cached for.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_TOKEN_CACHE_TIME_TO_LIVE
|
Duration |
10M
|
quarkus.oidc."tenant".logout.backchannel.clean-up-timer-interval
Token cache timer interval. If this property is set, a timer checks and removes the stale entries periodically.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_CLEAN_UP_TIMER_INTERVAL
|
Duration |
|
quarkus.oidc."tenant".logout.backchannel.logout-token-key
Logout token claim whose value is used as a key for caching the tokens. Only sub (subject) and sid (session id) claims can be used as keys. Set it to sid only if ID tokens issued by the OIDC provider have no sub but have sid claim.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_BACKCHANNEL_LOGOUT_TOKEN_KEY
|
string |
sub
|
quarkus.oidc."tenant".logout.frontchannel.path
The relative path of the Front-Channel Logout endpoint at the application.
Environment variable: QUARKUS_OIDC__TENANT__LOGOUT_FRONTCHANNEL_PATH
|
string |
|
quarkus.oidc."tenant".certificate-chain.leaf-certificate-name
Common name of the leaf certificate. It must be set if the trust-store-file does not have this certificate imported.
Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_LEAF_CERTIFICATE_NAME
|
string |
|
quarkus.oidc."tenant".certificate-chain.trust-store-file
Truststore file which keeps thumbprints of the trusted certificates.
Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE
|
path |
|
quarkus.oidc."tenant".certificate-chain.trust-store-password
A parameter to specify the password of the truststore file if it is configured with trust-store-file .
Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_PASSWORD
|
string |
|
quarkus.oidc."tenant".certificate-chain.trust-store-cert-alias
A parameter to specify the alias of the truststore certificate.
Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_CERT_ALIAS
|
string |
|
quarkus.oidc."tenant".certificate-chain.trust-store-file-type
An optional parameter to specify type of the truststore file. If not given, the type is automatically detected based on the file name.
Environment variable: QUARKUS_OIDC__TENANT__CERTIFICATE_CHAIN_TRUST_STORE_FILE_TYPE
|
string |
|
quarkus.oidc."tenant".authentication.response-mode
Authorization code flow response mode.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_RESPONSE_MODE
|
|
query
|
quarkus.oidc."tenant".authentication.redirect-path
The relative path for calculating a redirect_uri query parameter. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if the current request URI is https://localhost:8080/service , a redirect_uri parameter is set to https://localhost:8080/ if this property is set to / and be the same as the request URI if this property has not been configured. Note the original request URI is restored after the user has authenticated if restorePathAfterRedirect is set to true .
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_REDIRECT_PATH
|
string |
|
quarkus.oidc."tenant".authentication.restore-path-after-redirect
If this property is set to true , the original request URI which was used before the authentication is restored after the user has been redirected back to the application. Note if redirectPath property is not set, the original request URI is restored even if this property is disabled.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_RESTORE_PATH_AFTER_REDIRECT
|
boolean |
false
|
quarkus.oidc."tenant".authentication.remove-redirect-parameters
Remove the query parameters such as code and state set by the OIDC server on the redirect URI after the user has authenticated by redirecting a user to the same URI but without the query parameters.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_REMOVE_REDIRECT_PARAMETERS
|
boolean |
true
|
quarkus.oidc."tenant".authentication.error-path
Relative path to the public endpoint which processes the error response from the OIDC authorization endpoint. If the user authentication has failed, the OIDC provider returns an error and an optional error_description parameters, instead of the expected authorization code . If this property is set, the user is redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and is appended to the request URI’s host and port. For example, if it is set as /error and the current request URI is https://localhost:8080/callback?error=invalid_scope , a redirect is made to https://localhost:8080/error?error=invalid_scope . If this property is not set, HTTP 401 status is returned in case of the user authentication failure.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ERROR_PATH
|
string |
|
quarkus.oidc."tenant".authentication.session-expired-path
Relative path to the public endpoint which an authenticated user is redirected to when the session has expired.
When the OIDC session has expired and the session can not be refreshed, a user is redirected to the OIDC provider to re-authenticate. The user experience may not be ideal in this case as it may not be obvious to the authenticated user why an authentication challenge is returned.
Set this property if you would like the user whose session has expired be redirected to a public application specific page instead, which can inform that the session has expired and advise the user to re-authenticated by following a link to the secured initial entry page.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_EXPIRED_PATH
|
string |
|
quarkus.oidc."tenant".authentication.verify-access-token
Both ID and access tokens are fetched from the OIDC provider as part of the authorization code flow.
ID token is always verified on every user request as the primary token which is used to represent the principal and extract the roles.
Authorization code flow access token is meant to be propagated to downstream services and is not verified by default unless quarkus.oidc.roles.source property is set to accesstoken which means the authorization decision is based on the roles extracted from the access token.
Authorization code flow access token verification is also enabled if this token is injected as JsonWebToken. Set this property to false if it is not required.
Bearer access token is always verified.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_VERIFY_ACCESS_TOKEN
|
boolean |
true when access token is injected as the JsonWebToken bean, false otherwise
|
quarkus.oidc."tenant".authentication.force-redirect-https-scheme
Force https as the redirect_uri parameter scheme when running behind an SSL/TLS terminating reverse proxy. This property, if enabled, also affects the logout post_logout_redirect_uri and the local redirect requests.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FORCE_REDIRECT_HTTPS_SCHEME
|
boolean |
false
|
quarkus.oidc."tenant".authentication.scopes
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPES
|
list of string |
|
quarkus.oidc."tenant".authentication.scope-separator
The separator which is used when more than one scope is configured. A single space is used by default.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SCOPE_SEPARATOR
|
string |
|
quarkus.oidc."tenant".authentication.nonce-required
Require that ID token includes a nonce claim which must match nonce authentication request query parameter. Enabling this property can help mitigate replay attacks. Do not enable this property if your OpenId Connect provider does not support setting nonce in ID token or if you work with OAuth2 provider such as GitHub which does not issue ID tokens.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_NONCE_REQUIRED
|
boolean |
false
|
quarkus.oidc."tenant".authentication.add-openid-scope
Add the openid scope automatically to the list of scopes. This is required for OpenId Connect providers, but does not work for OAuth2 providers such as Twitter OAuth2, which do not accept this scope and throw errors.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ADD_OPENID_SCOPE
|
boolean |
true
|
quarkus.oidc."tenant".authentication.extra-params."parameter-name"
Additional properties added as query parameters to the authentication redirect URI.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_EXTRA_PARAMS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc."tenant".authentication.forward-params
Request URL query parameters which, if present, are added to the authentication redirect URI.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FORWARD_PARAMS
|
list of string |
|
quarkus.oidc."tenant".authentication.cookie-force-secure
If enabled the state, session, and post logout cookies have their secure parameter set to true when HTTP is used. It might be necessary when running behind an SSL/TLS terminating reverse proxy. The cookies are always secure if HTTPS is used, even if this property is set to false.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_FORCE_SECURE
|
boolean |
false
|
quarkus.oidc."tenant".authentication.cookie-suffix
Cookie name suffix. For example, a session cookie name for the default OIDC tenant is q_session but can be changed to q_session_test if this property is set to test .
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SUFFIX
|
string |
|
quarkus.oidc."tenant".authentication.cookie-path
Cookie path parameter value which, if set, is used to set a path parameter for the session, state and post logout cookies. The cookie-path-header property, if set, is checked first.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH
|
string |
/
|
quarkus.oidc."tenant".authentication.cookie-path-header
Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value is used to set a path parameter for the session, state and post logout cookies. If the header is missing, the cookie-path property is checked.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_PATH_HEADER
|
string |
|
quarkus.oidc."tenant".authentication.cookie-domain
Cookie domain parameter value which, if set, is used for the session, state and post logout cookies.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_DOMAIN
|
string |
|
quarkus.oidc."tenant".authentication.cookie-same-site
SameSite attribute for the session cookie.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_COOKIE_SAME_SITE
|
|
lax
|
quarkus.oidc."tenant".authentication.allow-multiple-code-flows
If a state cookie is present, a state query parameter must also be present and both the state cookie name suffix and state cookie value must match the value of the state query parameter when the redirect path matches the current path. However, if multiple authentications are attempted from the same browser, for example, from the different browser tabs, then the currently available state cookie might represent the authentication flow initiated from another tab and not related to the current request. Disable this property to permit only a single authorization code flow in the same browser.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ALLOW_MULTIPLE_CODE_FLOWS
|
boolean |
true
|
quarkus.oidc."tenant".authentication.fail-on-missing-state-param
Fail with the HTTP 401 error if the state cookie is present but no state query parameter is present.
When either multiple authentications are disabled or the redirect URL matches the original request URL, the stale state cookie might remain in the browser cache from the earlier failed redirect to an OpenId Connect provider and be visible during the current request. For example, if Single-page application (SPA) uses XHR to handle redirects to the provider which does not support CORS for its authorization endpoint, the browser blocks it and the state cookie created by Quarkus remains in the browser cache. Quarkus reports an authentication failure when it detects such an old state cookie but find no matching state query parameter.
Reporting HTTP 401 error is usually the right thing to do in such cases, it minimizes a risk of the browser redirect loop but also can identify problems in the way SPA or Quarkus application manage redirects. For example, enabling java-script-auto-redirect or having the provider redirect to URL configured with redirect-path might be needed to avoid such errors.
However, setting this property to false might help if the above options are not suitable. It causes a new authentication redirect to OpenId Connect provider. Doing so might increase the risk of browser redirect loops.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_FAIL_ON_MISSING_STATE_PARAM
|
boolean |
false
|
quarkus.oidc."tenant".authentication.user-info-required
If this property is set to true , an OIDC UserInfo endpoint is called.
This property is enabled automatically if quarkus.oidc.roles.source is set to userinfo or quarkus.oidc.token.verify-access-token-with-user-info is set to true or quarkus.oidc.authentication.id-token-required is set to false , the current OIDC tenant must support a UserInfo endpoint in these cases.
It is also enabled automatically if io.quarkus.oidc.UserInfo injection point is detected but only if the current OIDC tenant supports a UserInfo endpoint.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_USER_INFO_REQUIRED
|
boolean |
true when UserInfo bean is injected, false otherwise
|
quarkus.oidc."tenant".authentication.session-age-extension
Session age extension in minutes. The user session age property is set to the value of the ID token life-span by default and the user is redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a nonzero value, then the expired ID token can be refreshed before the session has expired. This property is ignored if the token.refresh-expired property has not been enabled.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_SESSION_AGE_EXTENSION
|
Duration |
5M
|
quarkus.oidc."tenant".authentication.state-cookie-age
State cookie age in minutes. State cookie is created every time a new authorization code flow redirect starts and removed when this flow is completed. State cookie name is unique by default, see allow-multiple-code-flows . Keep its age to the reasonable minimum value such as 5 minutes or less.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_COOKIE_AGE
|
Duration |
5M
|
quarkus.oidc."tenant".authentication.java-script-auto-redirect
If this property is set to true , a normal 302 redirect response is returned if the request was initiated by a JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated, which might not be desirable for Single-page applications (SPA) since it automatically following the redirect might not work given that OIDC authorization endpoints typically do not support CORS.
If this property is set to false , a status code of 499 is returned to allow SPA to handle the redirect manually if a request header identifying current request as a JavaScript request is found. X-Requested-With request header with its value set to either JavaScript or XMLHttpRequest is expected by default if this property is enabled. You can register a custom JavaScriptRequestChecker to do a custom JavaScript request check instead.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_JAVA_SCRIPT_AUTO_REDIRECT
|
boolean |
true
|
quarkus.oidc."tenant".authentication.id-token-required
Requires that ID token is available when the authorization code flow completes. Disable this property only when you need to use the authorization code flow with OAuth2 providers which do not return ID token - an internal IdToken is generated in such cases.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_ID_TOKEN_REQUIRED
|
boolean |
true
|
quarkus.oidc."tenant".authentication.internal-id-token-lifespan
Internal ID token lifespan. This property is only checked when an internal IdToken is generated when Oauth2 providers do not return IdToken.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_INTERNAL_ID_TOKEN_LIFESPAN
|
Duration |
5M
|
quarkus.oidc."tenant".authentication.pkce-required
Requires that a Proof Key for Code Exchange (PKCE) is used.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_PKCE_REQUIRED
|
boolean |
false
|
quarkus.oidc."tenant".authentication.state-secret
Secret used to encrypt Proof Key for Code Exchange (PKCE) code verifier and/or nonce in the code flow state. This secret should be at least 32 characters long.
If this secret is not set, the client secret configured with either quarkus.oidc.credentials.secret or quarkus.oidc.credentials.client-secret.value is checked. Finally, quarkus.oidc.credentials.jwt.secret which can be used for client_jwt_secret authentication is checked. A client secret is not be used as a state encryption secret if it is less than 32 characters long.
The secret is auto-generated if it remains uninitialized after checking all of these properties.
Error is reported if the secret length is less than 16 characters.
Environment variable: QUARKUS_OIDC__TENANT__AUTHENTICATION_STATE_SECRET
|
string |
|
quarkus.oidc."tenant".code-grant.extra-params."parameter-name"
Additional parameters, in addition to the required code and redirect-uri parameters, which must be included to complete the authorization code grant request.
Environment variable: QUARKUS_OIDC__TENANT__CODE_GRANT_EXTRA_PARAMS__PARAMETER_NAME_
|
Map<String,String> |
|
quarkus.oidc."tenant".code-grant.headers."header-name"
Custom HTTP headers which must be sent to complete the authorization code grant request.
Environment variable: QUARKUS_OIDC__TENANT__CODE_GRANT_HEADERS__HEADER_NAME_
|
Map<String,String> |
|
quarkus.oidc."tenant".token-state-manager.strategy
Default TokenStateManager strategy.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_STRATEGY
|
keep-all-tokens , id-token , id-refresh-tokens
|
keep-all-tokens
|
quarkus.oidc."tenant".token-state-manager.split-tokens
Default TokenStateManager keeps all tokens (ID, access and refresh) returned in the authorization code grant response in a single session cookie by default. Enable this property to minimize a session cookie size
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_SPLIT_TOKENS
|
boolean |
false
|
quarkus.oidc."tenant".token-state-manager.encryption-required
Mandates that the Default TokenStateManager encrypt the session cookie that stores the tokens.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_REQUIRED
|
boolean |
true
|
quarkus.oidc."tenant".token-state-manager.encryption-secret
The secret used by the Default TokenStateManager to encrypt the session cookie storing the tokens when encryption-required property is enabled.
If this secret is not set, the client secret configured with either quarkus.oidc.credentials.secret or quarkus.oidc.credentials.client-secret.value is checked. Finally, quarkus.oidc.credentials.jwt.secret which can be used for client_jwt_secret authentication is checked. The secret is auto-generated every time an application starts if it remains uninitialized after checking all of these properties. Generated secret can not decrypt the session cookie encrypted before the restart, therefore a user re-authentication will be required.
The length of the secret used to encrypt the tokens should be at least 32 characters long. A warning is logged if the secret length is less than 16 characters.
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_SECRET
|
string |
|
quarkus.oidc."tenant".token-state-manager.encryption-algorithm
Session cookie key encryption algorithm
Environment variable: QUARKUS_OIDC__TENANT__TOKEN_STATE_MANAGER_ENCRYPTION_ALGORITHM
|
|
a256-gcmkw
|
quarkus.oidc."tenant".allow-token-introspection-cache
Allow caching the token introspection data. Note enabling this property does not enable the cache itself but only permits to cache the token introspection for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.
Environment variable: QUARKUS_OIDC__TENANT__ALLOW_TOKEN_INTROSPECTION_CACHE
|
boolean |
true
|
quarkus.oidc."tenant".allow-user-info-cache
Allow caching the user info data. Note enabling this property does not enable the cache itself but only permits to cache the user info data for a given tenant. If the default token cache can be used, see OidcConfig.TokenCache to enable it.
Environment variable: QUARKUS_OIDC__TENANT__ALLOW_USER_INFO_CACHE
|
boolean |
true
|
quarkus.oidc."tenant".cache-user-info-in-idtoken
Allow inlining UserInfo in IdToken instead of caching it in the token cache. This property is only checked when an internal IdToken is generated when OAuth2 providers do not return IdToken. Inlining UserInfo in the generated IdToken allows to store it in the session cookie and avoids introducing a cached state.
Inlining UserInfo in the generated IdToken is enabled if the session cookie is encrypted and the UserInfo cache is not enabled or caching UserInfo is disabled for the current tenant with the allow-user-info-cache property set to false .
Environment variable: QUARKUS_OIDC__TENANT__CACHE_USER_INFO_IN_IDTOKEN
|
boolean |
|
quarkus.oidc."tenant".jwks.resolve-early
If JWK verification keys should be fetched at the moment a connection to the OIDC provider is initialized.
Disabling this property delays the key acquisition until the moment the current token has to be verified. Typically it can only be necessary if the token or other telated request properties provide an additional context which is required to resolve the keys correctly.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_RESOLVE_EARLY
|
boolean |
true
|
quarkus.oidc."tenant".jwks.cache-size
Maximum number of JWK keys that can be cached. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_CACHE_SIZE
|
int |
10
|
quarkus.oidc."tenant".jwks.cache-time-to-live
Number of minutes a JWK key can be cached for. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_CACHE_TIME_TO_LIVE
|
Duration |
10M
|
quarkus.oidc."tenant".jwks.clean-up-timer-interval
Cache timer interval. If this property is set, a timer checks and removes the stale entries periodically. This property is ignored if the resolve-early property is set to true.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_CLEAN_UP_TIMER_INTERVAL
|
Duration |
|
quarkus.oidc."tenant".jwks.try-all
In case there is no key identifier ('kid') or certificate thumbprints ('x5t', 'x5t#S256') specified in the JOSE header and no key could be determined, check all available keys matching the token algorithm ('alg') header value.
Environment variable: QUARKUS_OIDC__TENANT__JWKS_TRY_ALL
|
boolean |
false
|
quarkus.oidc."tenant".provider
Well known OpenId Connect provider identifier
Environment variable: QUARKUS_OIDC__TENANT__PROVIDER
|
apple , discord , facebook , github , google , linkedin , mastodon , microsoft , spotify , strava , twitch , twitter , x
|
|
OpenID Connect Client |
Type |
Default |
quarkus.oidc-client.enabled
If the OIDC client extension is enabled.
Environment variable: QUARKUS_OIDC_CLIENT_ENABLED
|
boolean |
true
|
quarkus.oidc-client.auth-server-url
Environment variable: QUARKUS_OIDC_CLIENT_AUTH_SERVER_URL
|
string |
|
quarkus.oidc-client.discovery-enabled
Environment variable: QUARKUS_OIDC_CLIENT_DISCOVERY_ENABLED
|
boolean |
true
|
quarkus.oidc-client.token-path
Environment variable: QUARKUS_OIDC_CLIENT_TOKEN_PATH
|
string |
|
quarkus.oidc-client.revoke-path
Environment variable: QUARKUS_OIDC_CLIENT_REVOKE_PATH
|
string |
|
quarkus.oidc-client.client-id
Environment variable: QUARKUS_OIDC_CLIENT_CLIENT_ID
|
string |
|
quarkus.oidc-client.client-name
Environment variable: QUARKUS_OIDC_CLIENT_CLIENT_NAME
|
string |
|
quarkus.oidc-client.connection-delay
Environment variable: QUARKUS_OIDC_CLIENT_CONNECTION_DELAY
|
Duration |
|
quarkus.oidc-client.connection-retry-count
Environment variable: QUARKUS_OIDC_CLIENT_CONNECTION_RETRY_COUNT
|
int |
3
|
quarkus.oidc-client.connection-timeout
Environment variable: QUARKUS_OIDC_CLIENT_CONNECTION_TIMEOUT
|
Duration |
10S
|
quarkus.oidc-client.use-blocking-dns-lookup
Environment variable: QUARKUS_OIDC_CLIENT_USE_BLOCKING_DNS_LOOKUP
|
boolean |
false
|
quarkus.oidc-client.max-pool-size
Environment variable: QUARKUS_OIDC_CLIENT_MAX_POOL_SIZE
|
int |
|
quarkus.oidc-client.credentials
Environment variable: QUARKUS_OIDC_CLIENT_CREDENTIALS
|
Credentials |
required |
quarkus.oidc-client.proxy
Environment variable: QUARKUS_OIDC_CLIENT_PROXY
|
Proxy |
required |
Environment variable: QUARKUS_OIDC_CLIENT_TLS
|
Tls |
required |
A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.
Environment variable: QUARKUS_OIDC_CLIENT_ID
|
string |
|
quarkus.oidc-client.client-enabled
If this client configuration is enabled.
Environment variable: QUARKUS_OIDC_CLIENT_CLIENT_ENABLED
|
boolean |
true
|
quarkus.oidc-client.scopes
List of access token scopes
Environment variable: QUARKUS_OIDC_CLIENT_SCOPES
|
list of string |
|
quarkus.oidc-client.refresh-token-time-skew
Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token’s expiration time then a refresh is going to happen.
Environment variable: QUARKUS_OIDC_CLIENT_REFRESH_TOKEN_TIME_SKEW
|
Duration |
|
quarkus.oidc-client.absolute-expires-in
If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
Environment variable: QUARKUS_OIDC_CLIENT_ABSOLUTE_EXPIRES_IN
|
boolean |
false
|
quarkus.oidc-client.grant.type
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_TYPE
|
client , password , code , exchange , jwt , refresh , ciba , device
|
client
|
quarkus.oidc-client.grant.access-token-property
Access token property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_ACCESS_TOKEN_PROPERTY
|
string |
access_token
|
quarkus.oidc-client.grant.refresh-token-property
Refresh token property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_REFRESH_TOKEN_PROPERTY
|
string |
refresh_token
|
quarkus.oidc-client.grant.expires-in-property
Access token expiry property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_EXPIRES_IN_PROPERTY
|
string |
expires_in
|
quarkus.oidc-client.grant.refresh-expires-in-property
Refresh token expiry property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_REFRESH_EXPIRES_IN_PROPERTY
|
string |
refresh_expires_in
|
quarkus.oidc-client.grant-options."grant-name"
Environment variable: QUARKUS_OIDC_CLIENT_GRANT_OPTIONS__GRANT_NAME_
|
Map<String,Map<String,String>> |
|
quarkus.oidc-client.early-tokens-acquisition
Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.
Environment variable: QUARKUS_OIDC_CLIENT_EARLY_TOKENS_ACQUISITION
|
boolean |
true
|
quarkus.oidc-client.headers."headers"
Custom HTTP headers which have to be sent to the token endpoint
Environment variable: QUARKUS_OIDC_CLIENT_HEADERS__HEADERS_
|
Map<String,String> |
|
Additional named clients |
Type |
Default |
quarkus.oidc-client."id".auth-server-url
Environment variable: QUARKUS_OIDC_CLIENT__ID__AUTH_SERVER_URL
|
string |
|
quarkus.oidc-client."id".discovery-enabled
Environment variable: QUARKUS_OIDC_CLIENT__ID__DISCOVERY_ENABLED
|
boolean |
true
|
quarkus.oidc-client."id".token-path
Environment variable: QUARKUS_OIDC_CLIENT__ID__TOKEN_PATH
|
string |
|
quarkus.oidc-client."id".revoke-path
Environment variable: QUARKUS_OIDC_CLIENT__ID__REVOKE_PATH
|
string |
|
quarkus.oidc-client."id".client-id
Environment variable: QUARKUS_OIDC_CLIENT__ID__CLIENT_ID
|
string |
|
quarkus.oidc-client."id".client-name
Environment variable: QUARKUS_OIDC_CLIENT__ID__CLIENT_NAME
|
string |
|
quarkus.oidc-client."id".connection-delay
Environment variable: QUARKUS_OIDC_CLIENT__ID__CONNECTION_DELAY
|
Duration |
|
quarkus.oidc-client."id".connection-retry-count
Environment variable: QUARKUS_OIDC_CLIENT__ID__CONNECTION_RETRY_COUNT
|
int |
3
|
quarkus.oidc-client."id".connection-timeout
Environment variable: QUARKUS_OIDC_CLIENT__ID__CONNECTION_TIMEOUT
|
Duration |
10S
|
quarkus.oidc-client."id".use-blocking-dns-lookup
Environment variable: QUARKUS_OIDC_CLIENT__ID__USE_BLOCKING_DNS_LOOKUP
|
boolean |
false
|
quarkus.oidc-client."id".max-pool-size
Environment variable: QUARKUS_OIDC_CLIENT__ID__MAX_POOL_SIZE
|
int |
|
quarkus.oidc-client."id".credentials
Environment variable: QUARKUS_OIDC_CLIENT__ID__CREDENTIALS
|
Credentials |
required |
quarkus.oidc-client."id".proxy
Environment variable: QUARKUS_OIDC_CLIENT__ID__PROXY
|
Proxy |
required |
quarkus.oidc-client."id".tls
Environment variable: QUARKUS_OIDC_CLIENT__ID__TLS
|
Tls |
required |
quarkus.oidc-client."id".id
A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases.
Environment variable: QUARKUS_OIDC_CLIENT__ID__ID
|
string |
|
quarkus.oidc-client."id".client-enabled
If this client configuration is enabled.
Environment variable: QUARKUS_OIDC_CLIENT__ID__CLIENT_ENABLED
|
boolean |
true
|
quarkus.oidc-client."id".scopes
List of access token scopes
Environment variable: QUARKUS_OIDC_CLIENT__ID__SCOPES
|
list of string |
|
quarkus.oidc-client."id".refresh-token-time-skew
Refresh token time skew in seconds. If this property is enabled then the configured number of seconds is added to the current time when checking whether the access token should be refreshed. If the sum is greater than this access token’s expiration time then a refresh is going to happen.
Environment variable: QUARKUS_OIDC_CLIENT__ID__REFRESH_TOKEN_TIME_SKEW
|
Duration |
|
quarkus.oidc-client."id".absolute-expires-in
If the access token 'expires_in' property should be checked as an absolute time value as opposed to a duration relative to the current time.
Environment variable: QUARKUS_OIDC_CLIENT__ID__ABSOLUTE_EXPIRES_IN
|
boolean |
false
|
quarkus.oidc-client."id".grant.type
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_TYPE
|
client , password , code , exchange , jwt , refresh , ciba , device
|
client
|
quarkus.oidc-client."id".grant.access-token-property
Access token property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_ACCESS_TOKEN_PROPERTY
|
string |
access_token
|
quarkus.oidc-client."id".grant.refresh-token-property
Refresh token property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_REFRESH_TOKEN_PROPERTY
|
string |
refresh_token
|
quarkus.oidc-client."id".grant.expires-in-property
Access token expiry property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_EXPIRES_IN_PROPERTY
|
string |
expires_in
|
quarkus.oidc-client."id".grant.refresh-expires-in-property
Refresh token expiry property name in a token grant response
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_REFRESH_EXPIRES_IN_PROPERTY
|
string |
refresh_expires_in
|
quarkus.oidc-client."id".grant-options."grant-name"
Environment variable: QUARKUS_OIDC_CLIENT__ID__GRANT_OPTIONS__GRANT_NAME_
|
Map<String,Map<String,String>> |
|
quarkus.oidc-client."id".early-tokens-acquisition
Requires that all filters which use 'OidcClient' acquire the tokens at the post-construct initialization time, possibly long before these tokens are used. This property should be disabled if the access token may expire before it is used for the first time and no refresh token is available.
Environment variable: QUARKUS_OIDC_CLIENT__ID__EARLY_TOKENS_ACQUISITION
|
boolean |
true
|
quarkus.oidc-client."id".headers."headers"
Custom HTTP headers which have to be sent to the token endpoint
Environment variable: QUARKUS_OIDC_CLIENT__ID__HEADERS__HEADERS_
|
Map<String,String> |
|
OpenID Connect Client integration for GraphQL client |
Type |
Default |
quarkus.oidc-client-graphql.client-name
Name of the configured OidcClient used by GraphQL clients. You can override this configuration for typesafe clients with the io.quarkus.oidc.client.filter.OidcClientFilter annotation.
Environment variable: QUARKUS_OIDC_CLIENT_GRAPHQL_CLIENT_NAME
|
string |
|
OpenID Connect Database Token State Manager |
Type |
Default |
quarkus.oidc.db-token-state-manager.enabled
Whether token state should be stored in the database.
Environment variable: QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_ENABLED
|
boolean |
true
|
quarkus.oidc.db-token-state-manager.delete-expired-delay
How often should Quarkus check for expired tokens.
Environment variable: QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_DELETE_EXPIRED_DELAY
|
Duration |
8H
|
quarkus.oidc.db-token-state-manager.create-database-table-if-not-exists
Whether Quarkus should attempt to create database table where the token state is going to be stored.
Environment variable: QUARKUS_OIDC_DB_TOKEN_STATE_MANAGER_CREATE_DATABASE_TABLE_IF_NOT_EXISTS
|
boolean |
true
|
OpenTelemetry |
Type |
Default |
If false, disable the OpenTelemetry usage at build time. All other Otel properties will be ignored at runtime.
Will pick up value from legacy property quarkus.opentelemetry.enabled
Environment variable: QUARKUS_OTEL_ENABLED
|
boolean |
true
|
quarkus.otel.traces.exporter
List of exporters supported by Quarkus.
List of exporters to be used for tracing, separated by commas. Has one of the values on ExporterType otlp , cdi , none or the full qualified name of a class implementing io.opentelemetry.sdk.trace.export.SpanExporter
Default on Quarkus is ExporterType.Constants#CDI_VALUE .
Environment variable: QUARKUS_OTEL_TRACES_EXPORTER
|
list of string |
cdi
|
quarkus.otel.traces.sampler
The sampler to use for tracing.
Has one of the values on SamplerType always_on , always_off , traceidratio , parentbased_always_on , parentbased_always_off , parentbased_traceidratio or the Sampler SPI name. This will use the OTel SPI hooks for the io.opentelemetry.sdk.trace.samplers.Sampler implementation set in the provider: io.opentelemetry.sdk.autoconfigure.spi.traces.ConfigurableSamplerProvider .
Fallbacks to the legacy property quarkus.opentelemetry.tracer.sampler.sampler.name or defaults to SamplerType.Constants#PARENT_BASED_ALWAYS_ON .
Environment variable: QUARKUS_OTEL_TRACES_SAMPLER
|
string |
parentbased_always_on
|
quarkus.otel.traces.eusp.enabled
If OpenTelemetry End User attributes should be added as Span attributes on a best-efforts basis.
Environment variable: QUARKUS_OTEL_TRACES_EUSP_ENABLED
|
boolean |
false
|
quarkus.otel.metrics.enabled
Enable metrics with OpenTelemetry.
This property is not available in the Open Telemetry SDK. It’s Quarkus specific.
Support for metrics will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset.
Environment variable: QUARKUS_OTEL_METRICS_ENABLED
|
boolean |
false
|
quarkus.otel.metrics.exporter
The Metrics exporter to use.
Environment variable: QUARKUS_OTEL_METRICS_EXPORTER
|
list of string |
cdi
|
quarkus.otel.logs.exporter
Environment variable: QUARKUS_OTEL_LOGS_EXPORTER
|
list of string |
none
|
The propagators to be used. Use a comma-separated list for multiple propagators.
Has values from PropagatorType or the full qualified name of a class implementing io.opentelemetry.context.propagation.TextMapPropagator .
Default is PropagatorType.Constants#TRACE_CONTEXT ,PropagatorType.Constants#BAGGAGE (W3C).
Environment variable: QUARKUS_OTEL_PROPAGATORS
|
list of string |
tracecontext,baggage
|
quarkus.otel.instrument.grpc
Enables instrumentation for gRPC.
Environment variable: QUARKUS_OTEL_INSTRUMENT_GRPC
|
boolean |
true
|
quarkus.otel.instrument.messaging
Enables instrumentation for Messaging.
Environment variable: QUARKUS_OTEL_INSTRUMENT_MESSAGING
|
boolean |
true
|
quarkus.otel.instrument.resteasy-client
Enables instrumentation for REST Client backed by RESTEasy Classic.
Environment variable: QUARKUS_OTEL_INSTRUMENT_RESTEASY_CLIENT
|
boolean |
true
|
quarkus.otel.instrument.rest
Enables instrumentation for Quarkus REST.
Environment variable: QUARKUS_OTEL_INSTRUMENT_REST
|
boolean |
true
|
quarkus.otel.instrument.resteasy
Enables instrumentation for RESTEasy Classic.
Environment variable: QUARKUS_OTEL_INSTRUMENT_RESTEASY
|
boolean |
true
|
quarkus.otel.security-events.enabled
Whether exporting of the security events is enabled.
Environment variable: QUARKUS_OTEL_SECURITY_EVENTS_ENABLED
|
boolean |
false
|
quarkus.otel.security-events.event-types
Selects security event types.
Environment variable: QUARKUS_OTEL_SECURITY_EVENTS_EVENT_TYPES
|
list of all , authentication-success , authentication-failure , authorization-success , authorization-failure , other
|
all
|
quarkus.otel.sdk.disabled
If true, disable the OpenTelemetry SDK. Runtime configuration.
Environment variable: QUARKUS_OTEL_SDK_DISABLED
|
boolean |
false
|
quarkus.otel.traces.suppress-non-application-uris
Suppress non-application uris from trace collection. This will suppress tracing of /q endpoints.
Providing a custom io.opentelemetry.sdk.trace.samplers.Sampler CDI Bean will ignore this setting.
This is a Quarkus specific property. Suppressing non-application uris is enabled by default.
Fallbacks to the legacy property quarkus.opentelemetry.tracer.suppress-non-application-uris or defaults to true .
Environment variable: QUARKUS_OTEL_TRACES_SUPPRESS_NON_APPLICATION_URIS
|
boolean |
true
|
quarkus.otel.traces.include-static-resources
Include static resources from trace collection.
This is a Quarkus specific property. Include static resources is disabled by default. Providing a custom io.opentelemetry.sdk.trace.samplers.Sampler CDI Bean will ignore this setting.
Fallbacks to the legacy property quarkus.opentelemetry.tracer.include-static-resources or defaults to false .
Environment variable: QUARKUS_OTEL_TRACES_INCLUDE_STATIC_RESOURCES
|
boolean |
false
|
quarkus.otel.traces.sampler.arg
Sampler argument. Depends on the quarkus.otel.traces.sampler property. Fallbacks to the legacy property quarkus.opentelemetry.tracer.sampler.ratio .
When setting the stock sampler to traceidratio or parentbased_traceidratio you need to set a double compatible value between 0.0d and 1.0d , like 0.01d or 0.5d . It is kept as a String to allow the flexible customisation of alternative samplers.
Environment variable: QUARKUS_OTEL_TRACES_SAMPLER_ARG
|
string |
1.0d
|
quarkus.otel.metric.export.interval
The interval, between the start of two metric export attempts.
Environment variable: QUARKUS_OTEL_METRIC_EXPORT_INTERVAL
|
Duration |
60S
|
quarkus.otel.attribute.value.length.limit
The maximum length of attribute values. Applies to spans and logs.
By default, there is no limit.
Environment variable: QUARKUS_OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
|
string |
|
quarkus.otel.attribute.count.limit
The maximum number of attributes. Applies to spans, span events, span links, and logs.
Environment variable: QUARKUS_OTEL_ATTRIBUTE_COUNT_LIMIT
|
int |
128
|
quarkus.otel.span.attribute.value.length.limit
The maximum length of span attribute values. Takes precedence over otel.attribute.value.length.limit .
By default, there is no limit.
Environment variable: QUARKUS_OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
|
int |
|
quarkus.otel.span.attribute.count.limit
The maximum number of attributes per span. Takes precedence over otel.attribute.count.limit .
Environment variable: QUARKUS_OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT
|
int |
128
|
quarkus.otel.span.event.count.limit
The maximum number of events per span.
Environment variable: QUARKUS_OTEL_SPAN_EVENT_COUNT_LIMIT
|
int |
128
|
quarkus.otel.span.link.count.limit
The maximum number of links per span.
Environment variable: QUARKUS_OTEL_SPAN_LINK_COUNT_LIMIT
|
int |
128
|
quarkus.otel.bsp.schedule.delay
The interval, in milliseconds, between two consecutive exports.
Environment variable: QUARKUS_OTEL_BSP_SCHEDULE_DELAY
|
Duration |
5S
|
quarkus.otel.bsp.max.queue.size
Environment variable: QUARKUS_OTEL_BSP_MAX_QUEUE_SIZE
|
int |
2048
|
quarkus.otel.bsp.max.export.batch.size
Environment variable: QUARKUS_OTEL_BSP_MAX_EXPORT_BATCH_SIZE
|
int |
512
|
quarkus.otel.bsp.export.timeout
The maximum allowed time, in milliseconds, to export data.
Environment variable: QUARKUS_OTEL_BSP_EXPORT_TIMEOUT
|
Duration |
30S
|
quarkus.otel.resource.attributes
Specify resource attributes in the following format: key1=val1,key2=val2,key3=val3 .
Environment variable: QUARKUS_OTEL_RESOURCE_ATTRIBUTES
|
list of string |
|
quarkus.otel.service.name
Specify logical service name. Takes precedence over service.name defined with otel.resource.attributes and from quarkus.application.name.
Defaults to quarkus.application.name .
Environment variable: QUARKUS_OTEL_SERVICE_NAME
|
string |
${quarkus.application.name:unset}
|
quarkus.otel.experimental.resource.disabled-keys
Specify resource attribute keys that are filtered.
Environment variable: QUARKUS_OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS
|
list of string |
|
quarkus.otel.experimental.shutdown-wait-time
The maximum amount of time Quarkus will wait for the OpenTelemetry SDK to flush unsent spans and shutdown.
Environment variable: QUARKUS_OTEL_EXPERIMENTAL_SHUTDOWN_WAIT_TIME
|
Duration |
1S
|
quarkus.otel.instrument.vertx-http
Enables instrumentation for Vert.x HTTP.
Environment variable: QUARKUS_OTEL_INSTRUMENT_VERTX_HTTP
|
boolean |
true
|
quarkus.otel.instrument.vertx-event-bus
Enables instrumentation for Vert.x Event Bus.
Environment variable: QUARKUS_OTEL_INSTRUMENT_VERTX_EVENT_BUS
|
boolean |
true
|
quarkus.otel.instrument.vertx-sql-client
Enables instrumentation for Vert.x SQL Client.
Environment variable: QUARKUS_OTEL_INSTRUMENT_VERTX_SQL_CLIENT
|
boolean |
true
|
quarkus.otel.instrument.vertx-redis-client
Enables instrumentation for Vert.x Redis Client.
Environment variable: QUARKUS_OTEL_INSTRUMENT_VERTX_REDIS_CLIENT
|
boolean |
true
|
quarkus.otel.mp.compatibility
Prioritize OpenTelemetry configuration otel. on top of Quarkus OpenTelemetry configuration quarkus.otel .
By default, Quarkus configuration has priority over OpenTelemetry configuration.
Environment variable: QUARKUS_OTEL_MP_COMPATIBILITY
|
boolean |
false
|
quarkus.otel.exporter.otlp.metrics.endpoint
Sets the OTLP endpoint to send telemetry data. If unset, defaults to OtlpExporterRuntimeConfig#DEFAULT_GRPC_BASE_URI .
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..endpoint where is one of the supported signal types, like traces or metrics .
If protocol is http/protobuf the version and signal will be appended to the path (e.g. v1/traces or v1/metrics) and the default port will be OtlpExporterRuntimeConfig#DEFAULT_HTTP_BASE_URI .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
|
string |
http://localhost:4317/
|
quarkus.otel.exporter.otlp.metrics.headers
Key-value pairs to be used as headers associated with exporter requests. The format is similar to the OTEL_EXPORTER_OTLP_HEADERS environment variable, a list of key-value pairs separated by the "=" character. i.e.: key1=value1,key2=value2
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..headers where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_HEADERS
|
list of string |
|
quarkus.otel.exporter.otlp.metrics.compression
Sets the method used to compress payloads. If unset, compression is disabled. Currently supported compression methods include gzip and none .
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..compression where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
|
|
|
quarkus.otel.exporter.otlp.metrics.timeout
Sets the maximum time to wait for the collector to process an exported batch of telemetry data. If unset, defaults to `OtlpExporterRuntimeConfig#DEFAULT_TIMEOUT_SECS`s.
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..timeout where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
|
Duration |
10S
|
quarkus.otel.exporter.otlp.metrics.protocol
OTLP defines the encoding of telemetry data and the protocol used to exchange data between the client and the server. Depending on the exporter, the available protocols will be different.
Currently, only grpc and http/protobuf are allowed.
Please mind that changing the protocol requires changing the port in the endpoint as well.
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..protocol where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROTOCOL
|
string |
grpc
|
quarkus.otel.exporter.otlp.metrics.key-cert.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_KEYS
|
list of string |
|
quarkus.otel.exporter.otlp.metrics.key-cert.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_KEY_CERT_CERTS
|
list of string |
|
quarkus.otel.exporter.otlp.metrics.trust-cert.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TRUST_CERT_CERTS
|
list of string |
|
quarkus.otel.exporter.otlp.metrics.tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..tls-configuration-name where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.otel.exporter.otlp.metrics.proxy-options.enabled
If proxy connection must be used.
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..proxy-options.enabled where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_ENABLED
|
boolean |
false
|
quarkus.otel.exporter.otlp.metrics.proxy-options.username
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..proxy-options.username where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_USERNAME
|
string |
|
quarkus.otel.exporter.otlp.metrics.proxy-options.password
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..proxy-options.password where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PASSWORD
|
string |
|
quarkus.otel.exporter.otlp.metrics.proxy-options.port
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..proxy-options.port where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_PORT
|
int |
|
quarkus.otel.exporter.otlp.metrics.proxy-options.host
There is a generic property, that will apply to all signals and a signal specific one, following the pattern: quarkus.otel.exporter.otlp..proxy-options.host where is one of the supported signal types, like traces or metrics .
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_PROXY_OPTIONS_HOST
|
string |
|
quarkus.otel.exporter.otlp.metrics.temporality-preference
The preferred output aggregation temporality. Options include DELTA, LOWMEMORY, and CUMULATIVE.
If CUMULATIVE, all instruments will have cumulative temporality. If DELTA, counter (sync and async) and histograms will be delta, up down counters (sync and async) will be cumulative. If LOWMEMORY, sync counter and histograms will be delta, async counter and up down counters (sync and async) will be cumulative.
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE
|
string |
cumulative
|
quarkus.otel.exporter.otlp.metrics.default-histogram-aggregation
The preferred default histogram aggregation.
Options include BASE2_EXPONENTIAL_BUCKET_HISTOGRAM and EXPLICIT_BUCKET_HISTOGRAM.
Default is EXPLICIT_BUCKET_HISTOGRAM.
Environment variable: QUARKUS_OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION
|
string |
explicit_bucket_histogram
|
Picocli |
Type |
Default |
quarkus.picocli.native-image.processing.enable
Set this to false to use the picocli-codegen annotation processor instead of build steps.
|
this will have serious build-time performance impact since this is run on every restart in dev mode, use with care!
|
This property is intended to be used only in cases where an incompatible change in the picocli library causes problems in the build steps used to support GraalVM Native images.
In such cases this property allows users to make the trade-off between fast build cycles with the older version of picocli, and temporarily accept slower build cycles with the latest version of picocli until the updated extension is available.
Environment variable: QUARKUS_PICOCLI_NATIVE_IMAGE_PROCESSING_ENABLE
|
boolean |
true
|
quarkus.picocli.top-command
Name of bean annotated with io.quarkus.picocli.runtime.annotations.TopCommand or FQCN of class which will be used as entry point for Picocli CommandLine instance. This class needs to be annotated with picocli.CommandLine.Command .
Environment variable: QUARKUS_PICOCLI_TOP_COMMAND
|
string |
|
Quarkus - Vert.x GraphQL |
Type |
Default |
quarkus.vertx-graphql.ui.always-include
If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode.
Environment variable: QUARKUS_VERTX_GRAPHQL_UI_ALWAYS_INCLUDE
|
boolean |
false
|
quarkus.vertx-graphql.ui.path
The path where GraphQL UI is available.
The value / is not allowed as it blocks the application from serving anything else.
Environment variable: QUARKUS_VERTX_GRAPHQL_UI_PATH
|
string |
graphql-ui
|
Quarkus Extension for Spring Cloud Config Client |
Type |
Default |
quarkus.spring-cloud-config.enabled
If enabled, will try to read the configuration from a Spring Cloud Config Server
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_ENABLED
|
boolean |
false
|
quarkus.spring-cloud-config.fail-fast
If set to true, the application will not stand up if it cannot obtain configuration from the Config Server
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_FAIL_FAST
|
boolean |
false
|
quarkus.spring-cloud-config.url
The Base URI where the Spring Cloud Config Server is available
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_URL
|
string |
http://localhost:8888
|
quarkus.spring-cloud-config.name
Name of the application on Spring Cloud Config server. Could be a list of names to load multiple files (value separated by a comma)
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_NAME
|
string |
${quarkus.application.name:}
|
quarkus.spring-cloud-config.label
The label to be used to pull remote configuration properties. The default is set on the Spring Cloud Config Server (generally "master" when the server uses a Git backend).
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_LABEL
|
string |
|
quarkus.spring-cloud-config.connection-timeout
The amount of time to wait when initially establishing a connection before giving up and timing out.
Specify 0 to wait indefinitely.
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_CONNECTION_TIMEOUT
|
Duration |
10S
|
quarkus.spring-cloud-config.read-timeout
The amount of time to wait for a read on a socket before an exception is thrown.
Specify 0 to wait indefinitely.
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_READ_TIMEOUT
|
Duration |
60S
|
quarkus.spring-cloud-config.username
The username to be used if the Config Server has BASIC Auth enabled
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_USERNAME
|
string |
|
quarkus.spring-cloud-config.password
The password to be used if the Config Server has BASIC Auth enabled
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_PASSWORD
|
string |
|
quarkus.spring-cloud-config.trust-store
TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE
|
path |
|
quarkus.spring-cloud-config.trust-store-password
Password of TrustStore to be used containing the SSL certificate used by the Config server
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_TRUST_STORE_PASSWORD
|
string |
|
quarkus.spring-cloud-config.key-store
KeyStore to be used containing the SSL certificate for authentication with the Config server Can be either a classpath resource or a file system path
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE
|
path |
|
quarkus.spring-cloud-config.key-store-password
Password of KeyStore to be used containing the SSL certificate for authentication with the Config server
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_KEY_STORE_PASSWORD
|
string |
|
quarkus.spring-cloud-config.key-password
Password to recover key from KeyStore for SSL client authentication with the Config server If no value is provided, the key-store-password will be used
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_KEY_PASSWORD
|
string |
|
quarkus.spring-cloud-config.trust-certs
When using HTTPS and no keyStore has been specified, whether to trust all certificates
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_TRUST_CERTS
|
boolean |
${quarkus.tls.trust-all:false}
|
quarkus.spring-cloud-config.headers."header-name"
Custom headers to pass the Spring Cloud Config Server when performing the HTTP request
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_HEADERS__HEADER_NAME_
|
Map<String,String> |
|
quarkus.spring-cloud-config.profiles
The profiles to use for lookup
Environment variable: QUARKUS_SPRING_CLOUD_CONFIG_PROFILES
|
list of string |
|
Quartz |
Type |
Default |
Enable cluster mode or not.
If enabled make sure to set the appropriate cluster properties.
Environment variable: QUARKUS_QUARTZ_CLUSTERED
|
boolean |
false
|
quarkus.quartz.cluster-checkin-interval
The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster.
Ignored if using a ram store i.e StoreType#RAM .
Environment variable: QUARKUS_QUARTZ_CLUSTER_CHECKIN_INTERVAL
|
long |
15000
|
quarkus.quartz.store-type
The type of store to use.
When using StoreType#JDBC_CMT or StoreType#JDBC_TX configuration values make sure that you have the datasource configured. See Configuring your datasource for more information.
Environment variable: QUARKUS_QUARTZ_STORE_TYPE
|
|
ram
|
quarkus.quartz.datasource
The name of the datasource to use.
Ignored if using a ram store i.e StoreType#RAM .
Optionally needed when using the jdbc-tx or jdbc-cmt store types. If not specified, defaults to using the default datasource.
Environment variable: QUARKUS_QUARTZ_DATASOURCE
|
string |
|
quarkus.quartz.table-prefix
The prefix for quartz job store tables.
Ignored if using a ram store i.e StoreType#RAM
Environment variable: QUARKUS_QUARTZ_TABLE_PREFIX
|
string |
QRTZ_
|
quarkus.quartz.select-with-lock-sql
The SQL string that selects a row in the "LOCKS" table and places a lock on the row.
Ignored if using a ram store i.e StoreType#RAM .
If not set, the default value of Quartz applies, for which the "{0}" is replaced during run-time with the table-prefix , the "{1}" with the instance-name .
An example SQL string SELECT * FROM {0}LOCKS WHERE SCHED_NAME = {1} AND LOCK_NAME = ? FOR UPDATE
Environment variable: QUARKUS_QUARTZ_SELECT_WITH_LOCK_SQL
|
string |
|
quarkus.quartz.serialize-job-data
Instructs JDBCJobStore to serialize JobDataMaps in the BLOB column.
Ignored if using a ram store i.e StoreType#RAM .
If this is set to true , the JDBCJobStore will store the JobDataMaps in their serialize form in the BLOB Column. This is useful when you want to store complex JobData objects other than String. This is equivalent of setting org.quartz.jobStore.useProperties to false . NOTE: When this option is set to true , all the non-String classes used in JobDataMaps have to be registered for serialization when building a native image
If this is set to false (the default), the values can be stored as name-value pairs rather than storing more complex objects in their serialized form in the BLOB column. This can be handy, as you avoid the class versioning issues that can arise from serializing your non-String classes into a BLOB. This is equivalent of setting org.quartz.jobStore.useProperties to true .
Environment variable: QUARKUS_QUARTZ_SERIALIZE_JOB_DATA
|
boolean |
false
|
quarkus.quartz.instance-name
The name of the Quartz instance.
Environment variable: QUARKUS_QUARTZ_INSTANCE_NAME
|
string |
QuarkusQuartzScheduler
|
quarkus.quartz.instance-id
The identifier of Quartz instance that must be unique for all schedulers working as if they are the same logical Scheduler within a cluster. Use the default value AUTO or some of the configured instance ID generators if you wish the identifier to be generated for you.
Environment variable: QUARKUS_QUARTZ_INSTANCE_ID
|
string |
AUTO
|
quarkus.quartz.batch-trigger-acquisition-fire-ahead-time-window
The amount of time in milliseconds that a trigger is allowed to be acquired and fired ahead of its scheduled fire time.
Environment variable: QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_FIRE_AHEAD_TIME_WINDOW
|
long |
0
|
quarkus.quartz.batch-trigger-acquisition-max-count
The maximum number of triggers that a scheduler node is allowed to acquire (for firing) at once.
Environment variable: QUARKUS_QUARTZ_BATCH_TRIGGER_ACQUISITION_MAX_COUNT
|
int |
1
|
quarkus.quartz.thread-count
The size of scheduler thread pool. This will initialize the number of worker threads in the pool.
Environment variable: QUARKUS_QUARTZ_THREAD_COUNT
|
int |
25
|
quarkus.quartz.thread-priority
Thread priority of worker threads in the pool.
Environment variable: QUARKUS_QUARTZ_THREAD_PRIORITY
|
int |
5
|
quarkus.quartz.misfire-threshold
Defines how late the schedulers should be to be considered misfired.
Environment variable: QUARKUS_QUARTZ_MISFIRE_THRESHOLD
|
Duration |
60S
|
quarkus.quartz.shutdown-wait-time
The maximum amount of time Quarkus will wait for currently running jobs to finish. If the value is 0 , then Quarkus will not wait at all for these jobs to finish - it will call org.quartz.Scheduler.shutdown(false) in this case.
Environment variable: QUARKUS_QUARTZ_SHUTDOWN_WAIT_TIME
|
Duration |
10S
|
quarkus.quartz.simple-trigger.misfire-policy
The quartz misfire policy for this job.
Environment variable: QUARKUS_QUARTZ_SIMPLE_TRIGGER_MISFIRE_POLICY
|
smart-policy , ignore-misfire-policy , fire-now , simple-trigger-reschedule-now-with-existing-repeat-count , simple-trigger-reschedule-now-with-remaining-repeat-count , simple-trigger-reschedule-next-with-remaining-count , simple-trigger-reschedule-next-with-existing-count , cron-trigger-do-nothing
|
smart-policy
|
quarkus.quartz.cron-trigger.misfire-policy
The quartz misfire policy for this job.
Environment variable: QUARKUS_QUARTZ_CRON_TRIGGER_MISFIRE_POLICY
|
smart-policy , ignore-misfire-policy , fire-now , simple-trigger-reschedule-now-with-existing-repeat-count , simple-trigger-reschedule-now-with-remaining-repeat-count , simple-trigger-reschedule-next-with-remaining-count , simple-trigger-reschedule-next-with-existing-count , cron-trigger-do-nothing
|
smart-policy
|
quarkus.quartz.run-blocking-scheduled-method-on-quartz-thread
When set to true , blocking scheduled methods are invoked on a thread managed by Quartz instead of a thread from the regular Quarkus thread pool (default).
When this option is enabled, blocking scheduled methods do not run on a duplicated context .
Environment variable: QUARKUS_QUARTZ_RUN_BLOCKING_SCHEDULED_METHOD_ON_QUARTZ_THREAD
|
boolean |
false
|
Misfire policy per job configuration |
Type |
Default |
quarkus.quartz.misfire-policy."identity"
The quartz misfire policy for this job.
Environment variable: QUARKUS_QUARTZ_MISFIRE_POLICY__IDENTITY_
|
smart-policy , ignore-misfire-policy , fire-now , simple-trigger-reschedule-now-with-existing-repeat-count , simple-trigger-reschedule-now-with-remaining-repeat-count , simple-trigger-reschedule-next-with-remaining-count , simple-trigger-reschedule-next-with-existing-count , cron-trigger-do-nothing
|
smart-policy
|
Instance ID generators |
Type |
Default |
quarkus.quartz.instance-id-generators."generator-name".class
Class name for the configuration.
Environment variable: QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__CLASS
|
string |
required |
quarkus.quartz.instance-id-generators."generator-name".properties."property-key"
The properties passed to the class.
Environment variable: QUARKUS_QUARTZ_INSTANCE_ID_GENERATORS__GENERATOR_NAME__PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Trigger listeners |
Type |
Default |
quarkus.quartz.trigger-listeners."listener-name".class
Class name for the configuration.
Environment variable: QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__CLASS
|
string |
required |
quarkus.quartz.trigger-listeners."listener-name".properties."property-key"
The properties passed to the class.
Environment variable: QUARKUS_QUARTZ_TRIGGER_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Job listeners |
Type |
Default |
quarkus.quartz.job-listeners."listener-name".class
Class name for the configuration.
Environment variable: QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__CLASS
|
string |
required |
quarkus.quartz.job-listeners."listener-name".properties."property-key"
The properties passed to the class.
Environment variable: QUARKUS_QUARTZ_JOB_LISTENERS__LISTENER_NAME__PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Plugins |
Type |
Default |
quarkus.quartz.plugins."plugin-name".class
Class name for the configuration.
Environment variable: QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__CLASS
|
string |
required |
quarkus.quartz.plugins."plugin-name".properties."property-key"
The properties passed to the class.
Environment variable: QUARKUS_QUARTZ_PLUGINS__PLUGIN_NAME__PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Qute |
Type |
Default |
The list of suffixes used when attempting to locate a template file.
By default, engine.getTemplate("foo") would result in several lookups: foo , foo.html , foo.txt , etc.
Environment variable: QUARKUS_QUTE_SUFFIXES
|
list of string |
qute.html,qute.txt,html,txt
|
quarkus.qute.content-types."file-suffix"
The additional map of suffixes to content types. This map is used when working with template variants. By default, the java.net.URLConnection#getFileNameMap() is used to determine the content type of a template file.
Environment variable: QUARKUS_QUTE_CONTENT_TYPES__FILE_SUFFIX_
|
Map<String,String> |
|
quarkus.qute.type-check-excludes
The list of exclude rules used to intentionally ignore some parts of an expression when performing type-safe validation.
An element value must have at least two parts separated by dot. The last part is used to match the property/method name. The prepended parts are used to match the class name. The value * can be used to match any name.
-
org.acme.Foo.name - exclude the property/method name on the org.acme.Foo class
-
org.acme.Foo.* - exclude any property/method on the org.acme.Foo class
-
*.age - exclude the property/method age on any class
Environment variable: QUARKUS_QUTE_TYPE_CHECK_EXCLUDES
|
list of string |
|
quarkus.qute.template-path-exclude
This regular expression is used to exclude template files from the templates directory. Excluded templates are neither parsed nor validated during build and are not available at runtime.
The matched input is the file path relative from the templates directory and the / is used as a path separator.
By default, the hidden files are excluded. The name of a hidden file starts with a dot.
Environment variable: QUARKUS_QUTE_TEMPLATE_PATH_EXCLUDE
|
Pattern |
^\..|.\/\..*$
|
quarkus.qute.iteration-metadata-prefix
The prefix is used to access the iteration metadata inside a loop section.
A valid prefix consists of alphanumeric characters and underscores. Three special constants can be used:
-
<alias_> - the alias of an iterated element suffixed with an underscore is used, e.g. item_hasNext and it_count
-
<alias?> - the alias of an iterated element suffixed with a question mark is used, e.g. item?hasNext and it?count
-
<none> - no prefix is used, e.g. hasNext and count By default, the <alias_> constant is set.
Environment variable: QUARKUS_QUTE_ITERATION_METADATA_PREFIX
|
string |
<alias_>
|
quarkus.qute.escape-content-types
The list of content types for which the ' , " , < , > and & characters are escaped if a template variant is set.
Environment variable: QUARKUS_QUTE_ESCAPE_CONTENT_TYPES
|
list of string |
text/html,text/xml,application/xml,application/xhtml+xml
|
quarkus.qute.default-charset
The default charset of the templates files.
Environment variable: QUARKUS_QUTE_DEFAULT_CHARSET
|
Charset |
UTF-8
|
quarkus.qute.dev-mode.no-restart-templates
By default, a template modification results in an application restart that triggers build-time validations.
This regular expression can be used to specify the templates for which the application is not restarted. I.e. the templates are reloaded and only runtime validations are performed.
The matched input is the template path that starts with a template root, and the / is used as a path separator. For example, templates/foo.html .
Environment variable: QUARKUS_QUTE_DEV_MODE_NO_RESTART_TEMPLATES
|
Pattern |
|
quarkus.qute.test-mode.record-rendered-results
By default, the rendering results of injected and type-safe templates are recorded in the managed RenderedResults which is registered as a CDI bean.
Environment variable: QUARKUS_QUTE_TEST_MODE_RECORD_RENDERED_RESULTS
|
boolean |
true
|
quarkus.qute.property-not-found-strategy
The strategy used when a standalone expression evaluates to a "not found" value at runtime and the quarkus.qute.strict-rendering config property is set to false
This strategy is never used when evaluating section parameters, e.g. {#if foo.name} . In such case, it’s the responsibility of the section to handle this situation appropriately.
By default, the NOT_FOUND constant is written to the output. However, in the development mode the PropertyNotFoundStrategy#THROW_EXCEPTION is used by default, i.e. when the strategy is not specified.
Environment variable: QUARKUS_QUTE_PROPERTY_NOT_FOUND_STRATEGY
|
default , noop , throw-exception , output-original
|
|
quarkus.qute.remove-standalone-lines
Specify whether the parser should remove standalone lines from the output. A standalone line is a line that contains at least one section tag, parameter declaration, or comment but no expression and no non-whitespace character.
Environment variable: QUARKUS_QUTE_REMOVE_STANDALONE_LINES
|
boolean |
true
|
quarkus.qute.strict-rendering
If set to true then any expression that is evaluated to a Results.NotFound value will always result in a TemplateException and the rendering is aborted.
Note that the quarkus.qute.property-not-found-strategy config property is completely ignored if strict rendering is enabled.
Environment variable: QUARKUS_QUTE_STRICT_RENDERING
|
boolean |
true
|
The global rendering timeout in milliseconds. It is used if no timeout template instance attribute is set.
Environment variable: QUARKUS_QUTE_TIMEOUT
|
long |
10000
|
quarkus.qute.use-async-timeout
If set to true then the timeout should also be used for asynchronous rendering methods, such as TemplateInstance#createUni() and TemplateInstance#renderAsync() .
Environment variable: QUARKUS_QUTE_USE_ASYNC_TIMEOUT
|
boolean |
true
|
Reactive datasource configuration |
Type |
Default |
quarkus.datasource.reactive
If we create a Reactive datasource for this datasource.
Environment variable: QUARKUS_DATASOURCE_REACTIVE
|
boolean |
true
|
quarkus.datasource.reactive.cache-prepared-statements
Whether prepared statements should be cached on the client side.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_CACHE_PREPARED_STATEMENTS
|
boolean |
false
|
quarkus.datasource.reactive.url
If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_URL
|
list of string |
|
quarkus.datasource.reactive.max-size
The datasource pool maximum size.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MAX_SIZE
|
int |
20
|
quarkus.datasource.reactive.event-loop-size
When a new connection object is created, the pool assigns it an event loop.
When #event-loop-size is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If #event-loop-size is set to zero or a negative value, the pool assigns the current event loop to the new connection.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_EVENT_LOOP_SIZE
|
int |
|
quarkus.datasource.reactive.trust-all
Whether all server certificates should be trusted.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_ALL
|
boolean |
false
|
quarkus.datasource.reactive.trust-certificate-pem
PEM Trust config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.datasource.reactive.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.datasource.reactive.trust-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.datasource.reactive.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.datasource.reactive.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.datasource.reactive.trust-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.datasource.reactive.trust-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.datasource.reactive.trust-certificate-pfx.password
Environment variable: QUARKUS_DATASOURCE_REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.datasource.reactive.key-certificate-pem
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.datasource.reactive.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.datasource.reactive.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.datasource.reactive.key-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.datasource.reactive.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.datasource.reactive.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.datasource.reactive.key-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.datasource.reactive.key-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.datasource.reactive.key-certificate-pfx.password
Environment variable: QUARKUS_DATASOURCE_REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.datasource.reactive.reconnect-attempts
The number of reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_RECONNECT_ATTEMPTS
|
int |
0
|
quarkus.datasource.reactive.reconnect-interval
The interval between reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_RECONNECT_INTERVAL
|
Duration |
PT1S
|
quarkus.datasource.reactive.hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS , LDAPS or NONE . NONE is the default value and disables the verification.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM
|
string |
NONE
|
quarkus.datasource.reactive.idle-timeout
The maximum time a connection remains unused in the pool before it is closed.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_IDLE_TIMEOUT
|
Duration |
no timeout
|
quarkus.datasource.reactive.max-lifetime
The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MAX_LIFETIME
|
Duration |
no timeout
|
quarkus.datasource.reactive.shared
Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the __vertx.DEFAULT name is used.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_SHARED
|
boolean |
false
|
quarkus.datasource.reactive.name
Set the pool name, used when the pool is shared among datasources, otherwise ignored.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_NAME
|
string |
|
quarkus.datasource.reactive.additional-properties."property-key"
Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Additional named datasources |
Type |
Default |
quarkus.datasource."datasource-name".reactive
If we create a Reactive datasource for this datasource.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE
|
boolean |
true
|
quarkus.datasource."datasource-name".reactive.cache-prepared-statements
Whether prepared statements should be cached on the client side.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_CACHE_PREPARED_STATEMENTS
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.url
If multiple values are set, this datasource will create a pool with a list of servers instead of a single server. The pool uses round-robin load balancing for server selection during connection establishment. Note that certain drivers might not accommodate multiple values in this context.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_URL
|
list of string |
|
quarkus.datasource."datasource-name".reactive.max-size
The datasource pool maximum size.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_SIZE
|
int |
20
|
quarkus.datasource."datasource-name".reactive.event-loop-size
When a new connection object is created, the pool assigns it an event loop.
When #event-loop-size is set to a strictly positive value, the pool assigns as many event loops as specified, in a round-robin fashion. By default, the number of event loops configured or calculated by Quarkus is used. If #event-loop-size is set to zero or a negative value, the pool assigns the current event loop to the new connection.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_EVENT_LOOP_SIZE
|
int |
|
quarkus.datasource."datasource-name".reactive.trust-all
Whether all server certificates should be trusted.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_ALL
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.trust-certificate-pem
PEM Trust config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.datasource."datasource-name".reactive.trust-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.datasource."datasource-name".reactive.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.datasource."datasource-name".reactive.trust-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.datasource."datasource-name".reactive.trust-certificate-pfx.password
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-pem
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.key-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.datasource."datasource-name".reactive.key-certificate-pfx.password
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.datasource."datasource-name".reactive.reconnect-attempts
The number of reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_ATTEMPTS
|
int |
0
|
quarkus.datasource."datasource-name".reactive.reconnect-interval
The interval between reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_RECONNECT_INTERVAL
|
Duration |
PT1S
|
quarkus.datasource."datasource-name".reactive.hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS , LDAPS or NONE . NONE is the default value and disables the verification.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_HOSTNAME_VERIFICATION_ALGORITHM
|
string |
NONE
|
quarkus.datasource."datasource-name".reactive.idle-timeout
The maximum time a connection remains unused in the pool before it is closed.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_IDLE_TIMEOUT
|
Duration |
no timeout
|
quarkus.datasource."datasource-name".reactive.max-lifetime
The maximum time a connection remains in the pool, after which it will be closed upon return and replaced as necessary.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_MAX_LIFETIME
|
Duration |
no timeout
|
quarkus.datasource."datasource-name".reactive.shared
Set to true to share the pool among datasources. There can be multiple shared pools distinguished by name, when no specific name is set, the __vertx.DEFAULT name is used.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_SHARED
|
boolean |
false
|
quarkus.datasource."datasource-name".reactive.name
Set the pool name, used when the pool is shared among datasources, otherwise ignored.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_NAME
|
string |
|
quarkus.datasource."datasource-name".reactive.additional-properties."property-key"
Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.
Environment variable: QUARKUS_DATASOURCE__DATASOURCE_NAME__REACTIVE_ADDITIONAL_PROPERTIES__PROPERTY_KEY_
|
Map<String,String> |
|
Reactive DB2 client |
Type |
Default |
Datasources |
Type |
Default |
quarkus.datasource.reactive.db2.ssl
quarkus.datasource."datasource-name".reactive.db2.ssl
Whether SSL/TLS is enabled.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_DB2_SSL
|
boolean |
false
|
Reactive MS SQL client |
Type |
Default |
Datasources |
Type |
Default |
quarkus.datasource.reactive.mssql.packet-size
quarkus.datasource."datasource-name".reactive.mssql.packet-size
The desired size (in bytes) for TDS packets.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MSSQL_PACKET_SIZE
|
int |
|
quarkus.datasource.reactive.mssql.ssl
quarkus.datasource."datasource-name".reactive.mssql.ssl
Whether SSL/TLS is enabled.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MSSQL_SSL
|
boolean |
false
|
Reactive MySQL client |
Type |
Default |
Additional named datasources |
Type |
Default |
quarkus.datasource.reactive.mysql.charset
quarkus.datasource."datasource-name".reactive.mysql.charset
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_CHARSET
|
string |
|
quarkus.datasource.reactive.mysql.collation
quarkus.datasource."datasource-name".reactive.mysql.collation
Collation for connections.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_COLLATION
|
string |
|
quarkus.datasource.reactive.mysql.ssl-mode
quarkus.datasource."datasource-name".reactive.mysql.ssl-mode
Desired security state of the connection to the server.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_SSL_MODE
|
disabled , preferred , required , verify-ca , verify-identity
|
disabled
|
quarkus.datasource.reactive.mysql.connection-timeout
quarkus.datasource."datasource-name".reactive.mysql.connection-timeout
Connection timeout in seconds
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_CONNECTION_TIMEOUT
|
int |
|
quarkus.datasource.reactive.mysql.authentication-plugin
quarkus.datasource."datasource-name".reactive.mysql.authentication-plugin
The authentication plugin the client should use. By default, it uses the plugin name specified by the server in the initial handshake packet.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_AUTHENTICATION_PLUGIN
|
default , mysql-clear-password , mysql-native-password , sha256-password , caching-sha2-password
|
default
|
quarkus.datasource.reactive.mysql.pipelining-limit
quarkus.datasource."datasource-name".reactive.mysql.pipelining-limit
The maximum number of inflight database commands that can be pipelined. By default, pipelining is disabled.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_PIPELINING_LIMIT
|
int |
|
quarkus.datasource.reactive.mysql.use-affected-rows
quarkus.datasource."datasource-name".reactive.mysql.use-affected-rows
Whether to return the number of rows matched by the WHERE clause in UPDATE statements, instead of the number of rows actually changed.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_MYSQL_USE_AFFECTED_ROWS
|
boolean |
false
|
Reactive Oracle client |
Type |
Default |
Datasources |
Type |
Default |
Reactive PostgreSQL client |
Type |
Default |
Datasources |
Type |
Default |
quarkus.datasource.reactive.postgresql.pipelining-limit
quarkus.datasource."datasource-name".reactive.postgresql.pipelining-limit
The maximum number of inflight database commands that can be pipelined.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_POSTGRESQL_PIPELINING_LIMIT
|
int |
|
quarkus.datasource.reactive.postgresql.ssl-mode
quarkus.datasource."datasource-name".reactive.postgresql.ssl-mode
SSL operating mode of the client.
Environment variable: QUARKUS_DATASOURCE_REACTIVE_POSTGRESQL_SSL_MODE
|
disable , allow , prefer , require , verify-ca , verify-full
|
disable
|
quarkus.datasource.reactive.postgresql.use-layer7-proxy
quarkus.datasource."datasource-name".reactive.postgresql.use-layer7-proxy
Level 7 proxies can load balance queries on several connections to the actual database. When it happens, the client can be confused by the lack of session affinity and unwanted errors can happen like ERROR: unnamed prepared statement does not exist (26000). See Using a level 7 proxy
Environment variable: QUARKUS_DATASOURCE_REACTIVE_POSTGRESQL_USE_LAYER7_PROXY
|
boolean |
false
|
Redis Cache |
Type |
Default |
quarkus.cache.redis.client-name
The name of the named Redis client to be used for communicating with Redis. If not set, use the default Redis client.
Environment variable: QUARKUS_CACHE_REDIS_CLIENT_NAME
|
string |
|
quarkus.cache.redis.value-type
The default type of the value stored in the cache.
Environment variable: QUARKUS_CACHE_REDIS_VALUE_TYPE
|
string |
|
quarkus.cache.redis.key-type
The key type, String by default.
Environment variable: QUARKUS_CACHE_REDIS_KEY_TYPE
|
string |
|
quarkus.cache.redis.expire-after-write
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.
Environment variable: QUARKUS_CACHE_REDIS_EXPIRE_AFTER_WRITE
|
Duration |
|
quarkus.cache.redis.expire-after-access
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.
Environment variable: QUARKUS_CACHE_REDIS_EXPIRE_AFTER_ACCESS
|
Duration |
|
quarkus.cache.redis.prefix
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
Environment variable: QUARKUS_CACHE_REDIS_PREFIX
|
string |
|
quarkus.cache.redis.use-optimistic-locking
Whether the access to the cache should be using optimistic locking. See Redis Optimistic Locking for details. Default is false .
Environment variable: QUARKUS_CACHE_REDIS_USE_OPTIMISTIC_LOCKING
|
boolean |
|
Additional configuration applied to a specific Redis cache (highest precedence) |
Type |
Default |
quarkus.cache.redis."cache-name".value-type
The default type of the value stored in the cache.
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__VALUE_TYPE
|
string |
|
quarkus.cache.redis."cache-name".key-type
The key type, String by default.
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__KEY_TYPE
|
string |
|
quarkus.cache.redis."cache-name".expire-after-write
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value.
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_WRITE
|
Duration |
|
quarkus.cache.redis."cache-name".expire-after-access
Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the last access of its value.
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__EXPIRE_AFTER_ACCESS
|
Duration |
|
quarkus.cache.redis."cache-name".prefix
the key prefix allowing to identify the keys belonging to the cache. If not set, use "cache:$cache-name"
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__PREFIX
|
string |
|
quarkus.cache.redis."cache-name".use-optimistic-locking
Whether the access to the cache should be using optimistic locking. See Redis Optimistic Locking for details. Default is false .
Environment variable: QUARKUS_CACHE_REDIS__CACHE_NAME__USE_OPTIMISTIC_LOCKING
|
boolean |
|
Redis Client |
Type |
Default |
quarkus.redis.load-script
A list of files allowing to pre-load data into the Redis server. The file is formatted as follows:
-
One instruction per line
-
Each instruction is a Redis command and its parameter such as HSET foo field value
-
Parameters can be wrapped into double-quotes if they include spaces
-
Parameters can be wrapped into single-quote if they include spaces
-
Parameters including double-quotes must be wrapped into single-quotes
Environment variable: QUARKUS_REDIS_LOAD_SCRIPT
|
list of string |
import.redis in DEV, TEST ; no-file otherwise
|
quarkus.redis.flush-before-load
When using redisLoadScript , indicates if the Redis database must be flushed (erased) before importing.
Environment variable: QUARKUS_REDIS_FLUSH_BEFORE_LOAD
|
boolean |
true
|
quarkus.redis.load-only-if-empty
When using redisLoadScript , indicates if the import should only happen if the database is empty (no keys).
Environment variable: QUARKUS_REDIS_LOAD_ONLY_IF_EMPTY
|
boolean |
true
|
quarkus.redis.health.enabled
Whether a health check is published in case the smallrye-health extension is present.
Environment variable: QUARKUS_REDIS_HEALTH_ENABLED
|
boolean |
true
|
The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.
The URI provided uses the following schema redis://[username:password@][host][:port][/database] Use quarkus.redis.hosts-provider-name to provide the hosts programmatically.
Environment variable: QUARKUS_REDIS_HOSTS
|
list of URI |
|
quarkus.redis.hosts-provider-name
The hosts provider bean name.
It is the @Named value of the hosts provider bean. It is used to discriminate if multiple io.quarkus.redis.client.RedisHostsProvider beans are available.
Used when quarkus.redis.hosts is not set.
Environment variable: QUARKUS_REDIS_HOSTS_PROVIDER_NAME
|
string |
|
The maximum delay to wait before a blocking command to redis server times out
Environment variable: QUARKUS_REDIS_TIMEOUT
|
Duration |
10S
|
quarkus.redis.client-type
The redis client type. Accepted values are: STANDALONE (default), CLUSTER , REPLICATION , SENTINEL .
Environment variable: QUARKUS_REDIS_CLIENT_TYPE
|
standalone , sentinel , cluster , replication
|
standalone
|
quarkus.redis.master-name
The master name (only considered in HA mode).
Environment variable: QUARKUS_REDIS_MASTER_NAME
|
string |
mymaster
|
The role name (only considered in Sentinel / HA mode). Accepted values are: MASTER , REPLICA , SENTINEL .
Environment variable: QUARKUS_REDIS_ROLE
|
master , replica , sentinel
|
master
|
Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: ALWAYS , NEVER , SHARE .
Environment variable: QUARKUS_REDIS_REPLICAS
|
|
never
|
The default password for cluster/sentinel connections.
If not set it will try to extract the value from the current default #hosts .
Environment variable: QUARKUS_REDIS_PASSWORD
|
string |
|
quarkus.redis.max-pool-size
The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels + 1)
Environment variable: QUARKUS_REDIS_MAX_POOL_SIZE
|
int |
6
|
quarkus.redis.max-pool-waiting
The maximum waiting requests for a connection from the pool.
Environment variable: QUARKUS_REDIS_MAX_POOL_WAITING
|
int |
24
|
quarkus.redis.pool-cleaner-interval
The duration indicating how often should the connection pool cleaner executes.
Environment variable: QUARKUS_REDIS_POOL_CLEANER_INTERVAL
|
Duration |
|
quarkus.redis.pool-recycle-timeout
The timeout for a connection recycling.
Environment variable: QUARKUS_REDIS_POOL_RECYCLE_TIMEOUT
|
Duration |
15S
|
quarkus.redis.max-waiting-handlers
Sets how many handlers is the client willing to queue.
The client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you’re willing to accept.
Environment variable: QUARKUS_REDIS_MAX_WAITING_HANDLERS
|
int |
2048
|
quarkus.redis.max-nested-arrays
Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
Environment variable: QUARKUS_REDIS_MAX_NESTED_ARRAYS
|
int |
32
|
quarkus.redis.reconnect-attempts
The number of reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_REDIS_RECONNECT_ATTEMPTS
|
int |
0
|
quarkus.redis.reconnect-interval
The interval between reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_REDIS_RECONNECT_INTERVAL
|
Duration |
1S
|
quarkus.redis.protocol-negotiation
Should the client perform RESP protocol negotiation during the connection handshake.
Environment variable: QUARKUS_REDIS_PROTOCOL_NEGOTIATION
|
boolean |
true
|
quarkus.redis.preferred-protocol-version
The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.
Environment variable: QUARKUS_REDIS_PREFERRED_PROTOCOL_VERSION
|
|
resp3
|
quarkus.redis.hash-slot-cache-ttl
The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending CLUSTER SLOTS commands to the first statically configured cluster node.
This setting is only meaningful in case of a clustered Redis client and has no effect otherwise.
Environment variable: QUARKUS_REDIS_HASH_SLOT_CACHE_TTL
|
Duration |
1S
|
quarkus.redis.tls-configuration-name
The name of the TLS configuration to use.
If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration name is set then, quarkus.redis.$client-name.tls will be used.
The default TLS configuration is not used by default.
Environment variable: QUARKUS_REDIS_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.redis."redis-client-name".load-script
A list of files allowing to pre-load data into the Redis server. The file is formatted as follows:
-
One instruction per line
-
Each instruction is a Redis command and its parameter such as HSET foo field value
-
Parameters can be wrapped into double-quotes if they include spaces
-
Parameters can be wrapped into single-quote if they include spaces
-
Parameters including double-quotes must be wrapped into single-quotes
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__LOAD_SCRIPT
|
list of string |
import.redis in DEV, TEST ; no-file otherwise
|
quarkus.redis."redis-client-name".flush-before-load
When using redisLoadScript , indicates if the Redis database must be flushed (erased) before importing.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__FLUSH_BEFORE_LOAD
|
boolean |
true
|
quarkus.redis."redis-client-name".load-only-if-empty
When using redisLoadScript , indicates if the import should only happen if the database is empty (no keys).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__LOAD_ONLY_IF_EMPTY
|
boolean |
true
|
quarkus.redis."redis-client-name".hosts
The redis hosts to use while connecting to the redis server. Only the cluster and sentinel modes will consider more than 1 element.
The URI provided uses the following schema redis://[username:password@][host][:port][/database] Use quarkus.redis.hosts-provider-name to provide the hosts programmatically.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS
|
list of URI |
|
quarkus.redis."redis-client-name".hosts-provider-name
The hosts provider bean name.
It is the @Named value of the hosts provider bean. It is used to discriminate if multiple io.quarkus.redis.client.RedisHostsProvider beans are available.
Used when quarkus.redis.hosts is not set.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__HOSTS_PROVIDER_NAME
|
string |
|
quarkus.redis."redis-client-name".timeout
The maximum delay to wait before a blocking command to redis server times out
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TIMEOUT
|
Duration |
10S
|
quarkus.redis."redis-client-name".client-type
The redis client type. Accepted values are: STANDALONE (default), CLUSTER , REPLICATION , SENTINEL .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__CLIENT_TYPE
|
standalone , sentinel , cluster , replication
|
standalone
|
quarkus.redis."redis-client-name".master-name
The master name (only considered in HA mode).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__MASTER_NAME
|
string |
mymaster
|
quarkus.redis."redis-client-name".role
The role name (only considered in Sentinel / HA mode). Accepted values are: MASTER , REPLICA , SENTINEL .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__ROLE
|
master , replica , sentinel
|
master
|
quarkus.redis."redis-client-name".replicas
Whether to use replicas nodes (only considered in Cluster mode). Accepted values are: ALWAYS , NEVER , SHARE .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__REPLICAS
|
|
never
|
quarkus.redis."redis-client-name".password
The default password for cluster/sentinel connections.
If not set it will try to extract the value from the current default #hosts .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__PASSWORD
|
string |
|
quarkus.redis."redis-client-name".max-pool-size
The maximum size of the connection pool. When working with cluster or sentinel, this value should be at least the total number of cluster members (or number of sentinels + 1)
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_SIZE
|
int |
6
|
quarkus.redis."redis-client-name".max-pool-waiting
The maximum waiting requests for a connection from the pool.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_POOL_WAITING
|
int |
24
|
quarkus.redis."redis-client-name".pool-cleaner-interval
The duration indicating how often should the connection pool cleaner executes.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_CLEANER_INTERVAL
|
Duration |
|
quarkus.redis."redis-client-name".pool-recycle-timeout
The timeout for a connection recycling.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__POOL_RECYCLE_TIMEOUT
|
Duration |
15S
|
quarkus.redis."redis-client-name".max-waiting-handlers
Sets how many handlers is the client willing to queue.
The client will always work on pipeline mode, this means that messages can start queueing. Using this configuration option, you can control how much backlog you’re willing to accept.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_WAITING_HANDLERS
|
int |
2048
|
quarkus.redis."redis-client-name".max-nested-arrays
Tune how much nested arrays are allowed on a redis response. This affects the parser performance.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__MAX_NESTED_ARRAYS
|
int |
32
|
quarkus.redis."redis-client-name".reconnect-attempts
The number of reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_ATTEMPTS
|
int |
0
|
quarkus.redis."redis-client-name".reconnect-interval
The interval between reconnection attempts when a pooled connection cannot be established on first try.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__RECONNECT_INTERVAL
|
Duration |
1S
|
quarkus.redis."redis-client-name".protocol-negotiation
Should the client perform RESP protocol negotiation during the connection handshake.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__PROTOCOL_NEGOTIATION
|
boolean |
true
|
quarkus.redis."redis-client-name".preferred-protocol-version
The preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__PREFERRED_PROTOCOL_VERSION
|
|
resp3
|
quarkus.redis."redis-client-name".hash-slot-cache-ttl
The TTL of the hash slot cache. A hash slot cache is used by the clustered Redis client to prevent constantly sending CLUSTER SLOTS commands to the first statically configured cluster node.
This setting is only meaningful in case of a clustered Redis client and has no effect otherwise.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__HASH_SLOT_CACHE_TTL
|
Duration |
1S
|
quarkus.redis."redis-client-name".tls-configuration-name
The name of the TLS configuration to use.
If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration name is set then, quarkus.redis.$client-name.tls will be used.
The default TLS configuration is not used by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_CONFIGURATION_NAME
|
string |
|
Dev Services |
Type |
Default |
quarkus.redis.devservices.enabled
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_REDIS_DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.redis.devservices.image-name
The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search…), use: redis/redis-stack:latest .
Environment variable: QUARKUS_REDIS_DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.redis.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_REDIS_DEVSERVICES_PORT
|
int |
|
quarkus.redis.devservices.shared
Indicates if the Redis 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 Redis starts a new container.
The discovery uses the quarkus-dev-service-redis label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_REDIS_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.redis.devservices.service-name
The value of the quarkus-dev-service-redis 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 Redis looks for a container with the quarkus-dev-service-redis 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-redis label set to the specified value.
This property is used when you need multiple shared Redis servers.
Environment variable: QUARKUS_REDIS_DEVSERVICES_SERVICE_NAME
|
string |
redis
|
quarkus.redis.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_REDIS_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Dev Services |
Type |
Default |
quarkus.redis."additional-redis-clients".devservices.enabled
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_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_ENABLED
|
boolean |
true
|
quarkus.redis."additional-redis-clients".devservices.image-name
The container image name to use, for container based DevServices providers. If you want to use Redis Stack modules (bloom, graph, search…), use: redis/redis-stack:latest .
Environment variable: QUARKUS_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_IMAGE_NAME
|
string |
|
quarkus.redis."additional-redis-clients".devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_PORT
|
int |
|
quarkus.redis."additional-redis-clients".devservices.shared
Indicates if the Redis 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 Redis starts a new container.
The discovery uses the quarkus-dev-service-redis label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.redis."additional-redis-clients".devservices.service-name
The value of the quarkus-dev-service-redis 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 Redis looks for a container with the quarkus-dev-service-redis 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-redis label set to the specified value.
This property is used when you need multiple shared Redis servers.
Environment variable: QUARKUS_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_SERVICE_NAME
|
string |
redis
|
quarkus.redis."additional-redis-clients".devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_REDIS__ADDITIONAL_REDIS_CLIENTS__DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
TCP config |
Type |
Default |
Environment variable: QUARKUS_REDIS_TCP_ALPN
|
boolean |
|
quarkus.redis.tcp.application-layer-protocols
Sets the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation .
Environment variable: QUARKUS_REDIS_TCP_APPLICATION_LAYER_PROTOCOLS
|
list of string |
|
quarkus.redis.tcp.secure-transport-protocols
Sets the list of enabled SSL/TLS protocols.
Environment variable: QUARKUS_REDIS_TCP_SECURE_TRANSPORT_PROTOCOLS
|
list of string |
|
quarkus.redis.tcp.idle-timeout
Environment variable: QUARKUS_REDIS_TCP_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis.tcp.connection-timeout
Environment variable: QUARKUS_REDIS_TCP_CONNECTION_TIMEOUT
|
Duration |
|
quarkus.redis.tcp.non-proxy-hosts
Set a list of remote hosts that are not proxied when the client is configured to use a proxy.
Environment variable: QUARKUS_REDIS_TCP_NON_PROXY_HOSTS
|
list of string |
|
quarkus.redis.tcp.proxy-options.username
Environment variable: QUARKUS_REDIS_TCP_PROXY_OPTIONS_USERNAME
|
string |
|
quarkus.redis.tcp.proxy-options.password
Environment variable: QUARKUS_REDIS_TCP_PROXY_OPTIONS_PASSWORD
|
string |
|
quarkus.redis.tcp.proxy-options.port
Set proxy port. Defaults to 3128.
Environment variable: QUARKUS_REDIS_TCP_PROXY_OPTIONS_PORT
|
int |
3128
|
quarkus.redis.tcp.proxy-options.host
Environment variable: QUARKUS_REDIS_TCP_PROXY_OPTIONS_HOST
|
string |
|
quarkus.redis.tcp.proxy-options.type
Set proxy type. Accepted values are: HTTP (default), SOCKS4 and SOCKS5 .
Environment variable: QUARKUS_REDIS_TCP_PROXY_OPTIONS_TYPE
|
|
http
|
quarkus.redis.tcp.read-idle-timeout
Set the read idle timeout.
Environment variable: QUARKUS_REDIS_TCP_READ_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis.tcp.receive-buffer-size
Set the TCP receive buffer size.
Environment variable: QUARKUS_REDIS_TCP_RECEIVE_BUFFER_SIZE
|
int |
|
quarkus.redis.tcp.reconnect-attempts
Set the value of reconnect attempts.
Environment variable: QUARKUS_REDIS_TCP_RECONNECT_ATTEMPTS
|
int |
|
quarkus.redis.tcp.reconnect-interval
Set the reconnect interval.
Environment variable: QUARKUS_REDIS_TCP_RECONNECT_INTERVAL
|
Duration |
|
quarkus.redis.tcp.reuse-address
Whether to reuse the address.
Environment variable: QUARKUS_REDIS_TCP_REUSE_ADDRESS
|
boolean |
|
quarkus.redis.tcp.reuse-port
Whether to reuse the port.
Environment variable: QUARKUS_REDIS_TCP_REUSE_PORT
|
boolean |
|
quarkus.redis.tcp.send-buffer-size
Set the TCP send buffer size.
Environment variable: QUARKUS_REDIS_TCP_SEND_BUFFER_SIZE
|
int |
|
quarkus.redis.tcp.so-linger
Set the SO_linger keep alive duration.
Environment variable: QUARKUS_REDIS_TCP_SO_LINGER
|
Duration |
|
Enable the TCP_CORK option - only with linux native transport.
Environment variable: QUARKUS_REDIS_TCP_CORK
|
boolean |
|
quarkus.redis.tcp.fast-open
Enable the TCP_FASTOPEN option - only with linux native transport.
Environment variable: QUARKUS_REDIS_TCP_FAST_OPEN
|
boolean |
|
quarkus.redis.tcp.keep-alive
Set whether keep alive is enabled
Environment variable: QUARKUS_REDIS_TCP_KEEP_ALIVE
|
boolean |
|
quarkus.redis.tcp.no-delay
Set whether no delay is enabled
Environment variable: QUARKUS_REDIS_TCP_NO_DELAY
|
boolean |
|
quarkus.redis.tcp.quick-ack
Enable the TCP_QUICKACK option - only with linux native transport.
Environment variable: QUARKUS_REDIS_TCP_QUICK_ACK
|
boolean |
|
quarkus.redis.tcp.traffic-class
Set the value of traffic class.
Environment variable: QUARKUS_REDIS_TCP_TRAFFIC_CLASS
|
int |
|
quarkus.redis.tcp.write-idle-timeout
Set the write idle timeout.
Environment variable: QUARKUS_REDIS_TCP_WRITE_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis.tcp.local-address
Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.
Environment variable: QUARKUS_REDIS_TCP_LOCAL_ADDRESS
|
string |
|
SSL/TLS config |
Type |
Default |
quarkus.redis.tls.enabled
Whether SSL/TLS is enabled.
Environment variable: QUARKUS_REDIS_TLS_ENABLED
|
boolean |
false
|
quarkus.redis.tls.trust-all
Enable trusting all certificates. Disabled by default.
Environment variable: QUARKUS_REDIS_TLS_TRUST_ALL
|
boolean |
false
|
quarkus.redis.tls.trust-certificate-pem
PEM Trust config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.redis.tls.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.redis.tls.trust-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.redis.tls.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.redis.tls.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.redis.tls.trust-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.redis.tls.trust-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.redis.tls.trust-certificate-pfx.password
Environment variable: QUARKUS_REDIS_TLS_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.redis.tls.key-certificate-pem
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.redis.tls.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.redis.tls.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.redis.tls.key-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.redis.tls.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.redis.tls.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.redis.tls.key-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.redis.tls.key-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.redis.tls.key-certificate-pfx.password
Environment variable: QUARKUS_REDIS_TLS_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.redis.tls.hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS , LDAPS or an NONE (default).
If set to NONE , it does not verify the hostname.
Environment variable: QUARKUS_REDIS_TLS_HOSTNAME_VERIFICATION_ALGORITHM
|
string |
NONE
|
TCP config |
Type |
Default |
quarkus.redis."redis-client-name".tcp.alpn
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_ALPN
|
boolean |
|
quarkus.redis."redis-client-name".tcp.application-layer-protocols
Sets the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_APPLICATION_LAYER_PROTOCOLS
|
list of string |
|
quarkus.redis."redis-client-name".tcp.secure-transport-protocols
Sets the list of enabled SSL/TLS protocols.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SECURE_TRANSPORT_PROTOCOLS
|
list of string |
|
quarkus.redis."redis-client-name".tcp.idle-timeout
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis."redis-client-name".tcp.connection-timeout
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CONNECTION_TIMEOUT
|
Duration |
|
quarkus.redis."redis-client-name".tcp.non-proxy-hosts
Set a list of remote hosts that are not proxied when the client is configured to use a proxy.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NON_PROXY_HOSTS
|
list of string |
|
quarkus.redis."redis-client-name".tcp.proxy-options.username
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_USERNAME
|
string |
|
quarkus.redis."redis-client-name".tcp.proxy-options.password
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PASSWORD
|
string |
|
quarkus.redis."redis-client-name".tcp.proxy-options.port
Set proxy port. Defaults to 3128.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_PORT
|
int |
3128
|
quarkus.redis."redis-client-name".tcp.proxy-options.host
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_HOST
|
string |
|
quarkus.redis."redis-client-name".tcp.proxy-options.type
Set proxy type. Accepted values are: HTTP (default), SOCKS4 and SOCKS5 .
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_PROXY_OPTIONS_TYPE
|
|
http
|
quarkus.redis."redis-client-name".tcp.read-idle-timeout
Set the read idle timeout.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_READ_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis."redis-client-name".tcp.receive-buffer-size
Set the TCP receive buffer size.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECEIVE_BUFFER_SIZE
|
int |
|
quarkus.redis."redis-client-name".tcp.reconnect-attempts
Set the value of reconnect attempts.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_ATTEMPTS
|
int |
|
quarkus.redis."redis-client-name".tcp.reconnect-interval
Set the reconnect interval.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_RECONNECT_INTERVAL
|
Duration |
|
quarkus.redis."redis-client-name".tcp.reuse-address
Whether to reuse the address.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_ADDRESS
|
boolean |
|
quarkus.redis."redis-client-name".tcp.reuse-port
Whether to reuse the port.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_REUSE_PORT
|
boolean |
|
quarkus.redis."redis-client-name".tcp.send-buffer-size
Set the TCP send buffer size.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SEND_BUFFER_SIZE
|
int |
|
quarkus.redis."redis-client-name".tcp.so-linger
Set the SO_linger keep alive duration.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_SO_LINGER
|
Duration |
|
quarkus.redis."redis-client-name".tcp.cork
Enable the TCP_CORK option - only with linux native transport.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_CORK
|
boolean |
|
quarkus.redis."redis-client-name".tcp.fast-open
Enable the TCP_FASTOPEN option - only with linux native transport.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_FAST_OPEN
|
boolean |
|
quarkus.redis."redis-client-name".tcp.keep-alive
Set whether keep alive is enabled
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_KEEP_ALIVE
|
boolean |
|
quarkus.redis."redis-client-name".tcp.no-delay
Set whether no delay is enabled
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_NO_DELAY
|
boolean |
|
quarkus.redis."redis-client-name".tcp.quick-ack
Enable the TCP_QUICKACK option - only with linux native transport.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_QUICK_ACK
|
boolean |
|
quarkus.redis."redis-client-name".tcp.traffic-class
Set the value of traffic class.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_TRAFFIC_CLASS
|
int |
|
quarkus.redis."redis-client-name".tcp.write-idle-timeout
Set the write idle timeout.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_WRITE_IDLE_TIMEOUT
|
Duration |
|
quarkus.redis."redis-client-name".tcp.local-address
Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TCP_LOCAL_ADDRESS
|
string |
|
SSL/TLS config |
Type |
Default |
quarkus.redis."redis-client-name".tls.enabled
Whether SSL/TLS is enabled.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_ENABLED
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.trust-all
Enable trusting all certificates. Disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_ALL
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.trust-certificate-pem
PEM Trust config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.redis."redis-client-name".tls.trust-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.redis."redis-client-name".tls.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.redis."redis-client-name".tls.trust-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.trust-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.redis."redis-client-name".tls.trust-certificate-pfx.password
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.redis."redis-client-name".tls.key-certificate-pem
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.redis."redis-client-name".tls.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.redis."redis-client-name".tls.key-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.redis."redis-client-name".tls.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.redis."redis-client-name".tls.key-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.redis."redis-client-name".tls.key-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.redis."redis-client-name".tls.key-certificate-pfx.password
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.redis."redis-client-name".tls.hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS , LDAPS or an NONE (default).
If set to NONE , it does not verify the hostname.
Environment variable: QUARKUS_REDIS__REDIS_CLIENT_NAME__TLS_HOSTNAME_VERIFICATION_ALGORITHM
|
string |
NONE
|
REST - Cross-Site Request Forgery Prevention Filter |
Type |
Default |
quarkus.rest-csrf.enabled
Environment variable: QUARKUS_REST_CSRF_ENABLED
|
boolean |
true
|
quarkus.rest-csrf.form-field-name
Form field name which keeps a CSRF token.
Environment variable: QUARKUS_REST_CSRF_FORM_FIELD_NAME
|
string |
csrf-token
|
quarkus.rest-csrf.token-header-name
Token header which can provide a CSRF token.
Environment variable: QUARKUS_REST_CSRF_TOKEN_HEADER_NAME
|
string |
X-CSRF-TOKEN
|
quarkus.rest-csrf.cookie-name
Environment variable: QUARKUS_REST_CSRF_COOKIE_NAME
|
string |
csrf-token
|
quarkus.rest-csrf.cookie-max-age
Environment variable: QUARKUS_REST_CSRF_COOKIE_MAX_AGE
|
Duration |
2H
|
quarkus.rest-csrf.cookie-path
Environment variable: QUARKUS_REST_CSRF_COOKIE_PATH
|
string |
/
|
quarkus.rest-csrf.cookie-domain
Environment variable: QUARKUS_REST_CSRF_COOKIE_DOMAIN
|
string |
|
quarkus.rest-csrf.cookie-force-secure
If enabled the CSRF cookie will have its 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookie will always be secure if HTTPS is used even if this property is set to false.
Environment variable: QUARKUS_REST_CSRF_COOKIE_FORCE_SECURE
|
boolean |
false
|
quarkus.rest-csrf.cookie-http-only
Set the HttpOnly attribute to prevent access to the cookie via JavaScript.
Environment variable: QUARKUS_REST_CSRF_COOKIE_HTTP_ONLY
|
boolean |
true
|
quarkus.rest-csrf.create-token-path
Create CSRF token only if the HTTP GET relative request path matches one of the paths configured with this property. Use a comma to separate multiple path values.
Environment variable: QUARKUS_REST_CSRF_CREATE_TOKEN_PATH
|
list of string |
|
quarkus.rest-csrf.token-size
Random CSRF token size in bytes.
Environment variable: QUARKUS_REST_CSRF_TOKEN_SIZE
|
int |
16
|
quarkus.rest-csrf.token-signature-key
CSRF token HMAC signature key, if this key is set then it must be at least 32 characters long.
Environment variable: QUARKUS_REST_CSRF_TOKEN_SIGNATURE_KEY
|
string |
|
quarkus.rest-csrf.verify-token
Verify CSRF token in the CSRF filter. If you prefer then you can disable this property and compare CSRF form and cookie parameters in the application code using JAX-RS jakarta.ws.rs.FormParam which refers to the form-field-name form property and jakarta.ws.rs.CookieParam which refers to the RestCsrfConfig#cookieName cookie. Note that even if the CSRF token verification in the CSRF filter is disabled, the filter will still perform checks to ensure the token is available, has the correct token-size in bytes and that the Content-Type HTTP header is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.
Environment variable: QUARKUS_REST_CSRF_VERIFY_TOKEN
|
boolean |
true
|
quarkus.rest-csrf.require-form-url-encoded
Require that only 'application/x-www-form-urlencoded' or 'multipart/form-data' body is accepted for the token verification to proceed. Disable this property for the CSRF filter to avoid verifying the token for POST requests with other content types. This property is only effective if verify-token property is enabled and token-header-name is not configured.
Environment variable: QUARKUS_REST_CSRF_REQUIRE_FORM_URL_ENCODED
|
boolean |
true
|
REST - Jackson |
Type |
Default |
quarkus.rest.jackson.optimization.enable-reflection-free-serializers
Enable build time generation of reflection-free Jackson serializers.
Environment variable: QUARKUS_REST_JACKSON_OPTIMIZATION_ENABLE_REFLECTION_FREE_SERIALIZERS
|
boolean |
false
|
REST - Qute |
Type |
Default |
REST Client |
Type |
Default |
quarkus.rest-client.provider-autodiscovery
Whether providers (filters, etc.) annotated with jakarta.ws.rs.ext.Provider should be automatically registered for all the clients in the application.
Environment variable: QUARKUS_REST_CLIENT_PROVIDER_AUTODISCOVERY
|
boolean |
true
|
REST Client - OpenID Connect Filter |
Type |
Default |
quarkus.rest-client-oidc-filter.client-name
Name of the configured OidcClient used by the OidcClientRequestReactiveFilter. You can override this configuration for individual MP RestClients with the io.quarkus.oidc.client.filter.OidcClientFilter annotation.
Environment variable: QUARKUS_REST_CLIENT_OIDC_FILTER_CLIENT_NAME
|
string |
|
REST Client - OpenID Connect Token Propagation |
Type |
Default |
quarkus.rest-client-oidc-token-propagation.enabled
If the OIDC Token Reactive Propagation is enabled.
Environment variable: QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED
|
boolean |
true
|
quarkus.rest-client-oidc-token-propagation.enabled-during-authentication
Whether the token propagation is enabled during the SecurityIdentity augmentation.
For example, you may need to use a REST client from SecurityIdentityAugmentor
to propagate the current token to acquire additional roles for the SecurityIdentity .
Note, this feature relies on a duplicated context. More information about Vert.x duplicated
context can be found in this guide.
Environment variable: QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED_DURING_AUTHENTICATION
|
boolean |
false
|
quarkus.rest-client-oidc-token-propagation.exchange-token
Exchange the current token with OpenId Connect Provider for a new token using either "urn:ietf:params:oauth:grant-type:token-exchange" or "urn:ietf:params:oauth:grant-type:jwt-bearer" token grant before propagating it.
Environment variable: QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_EXCHANGE_TOKEN
|
boolean |
false
|
quarkus.rest-client-oidc-token-propagation.client-name
Name of the configured OidcClient. Note this property is only used if the exchangeToken property is enabled.
Environment variable: QUARKUS_REST_CLIENT_OIDC_TOKEN_PROPAGATION_CLIENT_NAME
|
string |
|
REST Clients Config |
Type |
Default |
quarkus.rest-client.multipart-post-encoder-mode
Mode in which the form data are encoded. Possible values are HTML5 , RFC1738 and RFC3986 . The modes are described in the Netty documentation
By default, Rest Client Reactive uses RFC1738.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_MULTIPART_POST_ENCODER_MODE
|
string |
|
quarkus.rest-client.proxy-address
A string value in the form of : that specifies the HTTP proxy server hostname (or IP address) and port for requests of clients to use.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_PROXY_ADDRESS
|
string |
|
quarkus.rest-client.proxy-user
Proxy username, equivalent to the http.proxy or https.proxy JVM settings.
Can be overwritten by client-specific settings.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_PROXY_USER
|
string |
|
quarkus.rest-client.proxy-password
Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings.
Can be overwritten by client-specific settings.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_PROXY_PASSWORD
|
string |
|
quarkus.rest-client.non-proxy-hosts
Hosts to access without proxy, similar to the http.nonProxyHosts or https.nonProxyHosts JVM settings. Please note that unlike the JVM settings, this property is empty by default.
Can be overwritten by client-specific settings.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_NON_PROXY_HOSTS
|
string |
|
quarkus.rest-client.connect-timeout
A timeout in milliseconds that REST clients should wait to connect to the remote endpoint.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_CONNECT_TIMEOUT
|
long |
15000
|
quarkus.rest-client.read-timeout
A timeout in milliseconds that REST clients should wait for a response from the remote endpoint.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_READ_TIMEOUT
|
long |
30000
|
quarkus.rest-client.disable-contextual-error-messages
If true, the REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_DISABLE_CONTEXTUAL_ERROR_MESSAGES
|
boolean |
false
|
quarkus.rest-client.user-agent
Default configuration for the HTTP user-agent header to use in all REST clients.
Can be overwritten by client-specific settings.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_USER_AGENT
|
string |
|
quarkus.rest-client.headers."header-name"
The HTTP headers that should be applied to all requests of the rest client.
Environment variable: QUARKUS_REST_CLIENT_HEADERS__HEADER_NAME_
|
Map<String,String> |
|
quarkus.rest-client.hostname-verifier
The class name of the host name verifier. The class must have a public no-argument constructor.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_HOSTNAME_VERIFIER
|
string |
|
quarkus.rest-client.connection-ttl
The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of 0 means there is no timeout.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_CONNECTION_TTL
|
int |
|
quarkus.rest-client.connection-pool-size
The size of the connection pool for this client.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_CONNECTION_POOL_SIZE
|
int |
|
quarkus.rest-client.keep-alive-enabled
If set to false disables the keep alive completely.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_KEEP_ALIVE_ENABLED
|
boolean |
true
|
quarkus.rest-client.max-redirects
The maximum number of redirection a request can follow.
Can be overwritten by client-specific settings.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_MAX_REDIRECTS
|
int |
|
quarkus.rest-client.follow-redirects
A boolean value used to determine whether the client should follow HTTP redirect responses.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_FOLLOW_REDIRECTS
|
boolean |
|
quarkus.rest-client.providers
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the @RegisterProvider annotation.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_PROVIDERS
|
string |
|
quarkus.rest-client.scope
The CDI scope to use for injections of REST client instances. Value can be either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as"ApplicationScoped").
Default scope for the rest-client extension is "Dependent" (which is the spec-compliant behavior).
Default scope for the rest-client-reactive extension is "ApplicationScoped".
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_SCOPE
|
string |
|
quarkus.rest-client.query-param-style
An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED", or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_QUERY_PARAM_STYLE
|
multi-pairs , comma-separated , array-pairs
|
|
quarkus.rest-client.verify-host
Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_VERIFY_HOST
|
boolean |
|
quarkus.rest-client.trust-store
The trust store location. Can point to either a classpath resource or a file.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_TRUST_STORE
|
string |
|
quarkus.rest-client.trust-store-password
The trust store password.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_TRUST_STORE_PASSWORD
|
string |
|
quarkus.rest-client.trust-store-type
The type of the trust store. Defaults to "JKS".
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_TRUST_STORE_TYPE
|
string |
|
quarkus.rest-client.key-store
The key store location. Can point to either a classpath resource or a file.
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_KEY_STORE
|
string |
|
quarkus.rest-client.key-store-password
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_KEY_STORE_PASSWORD
|
string |
|
quarkus.rest-client.key-store-type
The type of the key store. Defaults to "JKS".
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_KEY_STORE_TYPE
|
string |
|
quarkus.rest-client.tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.rest-client.http2
If this is true then HTTP/2 will be enabled.
Environment variable: QUARKUS_REST_CLIENT_HTTP2
|
boolean |
false
|
quarkus.rest-client.max-chunk-size
The max HTTP chunk size (8096 bytes by default).
Can be overwritten by client-specific settings.
Environment variable: QUARKUS_REST_CLIENT_MAX_CHUNK_SIZE
|
MemorySize |
8k
|
If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it’s not enabled, it will use HTTP/1.1. When the property http2 is enabled, this flag will be automatically enabled.
Environment variable: QUARKUS_REST_CLIENT_ALPN
|
boolean |
|
quarkus.rest-client.capture-stacktrace
If true , the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
Environment variable: QUARKUS_REST_CLIENT_CAPTURE_STACKTRACE
|
boolean |
true
|
quarkus.rest-client.logging.scope
Scope of logging for the client.
WARNING: beware of logging sensitive data
The possible values are:
-
request-response - enables logging request and responses, including redirect responses
-
all - enables logging requests and responses and lower-level logging
-
none - no additional logging This property is applicable to reactive REST clients only.
Environment variable: QUARKUS_REST_CLIENT_LOGGING_SCOPE
|
string |
|
quarkus.rest-client.logging.body-limit
How many characters of the body should be logged. Message body can be large and can easily pollute the logs.
This property is applicable to reactive REST clients only.
Environment variable: QUARKUS_REST_CLIENT_LOGGING_BODY_LIMIT
|
int |
100
|
quarkus.rest-client."clients".scope
The CDI scope to use for injection. This property can contain either a fully qualified class name of a CDI scope annotation (such as "jakarta.enterprise.context.ApplicationScoped") or its simple name (such as "ApplicationScoped"). By default, this is not set which means the interface is not registered as a bean unless it is annotated with RegisterRestClient . If an interface is not annotated with RegisterRestClient and this property is set, then Quarkus will make the interface a bean of the configured scope.
Environment variable: QUARKUS_REST_CLIENT__CLIENTS__SCOPE
|
string |
|
quarkus.rest-client."clients".enable-local-proxy
If set to true, then Quarkus will ensure that all calls from the REST client go through a local proxy server (that is managed by Quarkus). This can be very useful for capturing network traffic to a service that uses HTTPS.
This property is not applicable to the RESTEasy Client, only the Quarkus REST client (formerly RESTEasy Reactive client).
This property only applicable to dev and test mode.
Environment variable: QUARKUS_REST_CLIENT__CLIENTS__ENABLE_LOCAL_PROXY
|
boolean |
false
|
quarkus.rest-client."clients".local-proxy-provider
This setting is used to select which proxy provider to use if there are multiple ones. It only applies if enable-local-proxy is true.
The algorithm for picking between multiple provider is the following:
-
If only the default is around, use it (its name is default )
-
If there is only one besides the default, use it
-
If there are multiple ones, fail
Environment variable: QUARKUS_REST_CLIENT__CLIENTS__LOCAL_PROXY_PROVIDER
|
string |
|
quarkus.rest-client."client".url
The base URL to use for this service. This property or the uri property is considered required, unless the baseUri attribute is configured in the @RegisterRestClient annotation.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__URL
|
string |
|
quarkus.rest-client."client".uri
The base URI to use for this service. This property or the url property is considered required, unless the baseUri attribute is configured in the @RegisterRestClient annotation.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__URI
|
string |
|
quarkus.rest-client."client".override-uri
This property is only meant to be set by advanced configurations to override whatever value was set for the uri or url. The override is done using the REST Client class name configuration syntax.
This property is not applicable to the RESTEasy Client, only the Quarkus Rest client (formerly RESTEasy Reactive client).
Environment variable: QUARKUS_REST_CLIENT__CLIENT__OVERRIDE_URI
|
string |
|
quarkus.rest-client."client".providers
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the @RegisterProvider annotation.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__PROVIDERS
|
string |
|
quarkus.rest-client."client".connect-timeout
Timeout specified in milliseconds to wait to connect to the remote endpoint.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__CONNECT_TIMEOUT
|
long |
|
quarkus.rest-client."client".read-timeout
Timeout specified in milliseconds to wait for a response from the remote endpoint.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__READ_TIMEOUT
|
long |
|
quarkus.rest-client."client".follow-redirects
A boolean value used to determine whether the client should follow HTTP redirect responses.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__FOLLOW_REDIRECTS
|
boolean |
|
quarkus.rest-client."client".multipart-post-encoder-mode
Mode in which the form data are encoded. Possible values are HTML5 , RFC1738 and RFC3986 . The modes are described in the Netty documentation
By default, Rest Client Reactive uses RFC1738.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__MULTIPART_POST_ENCODER_MODE
|
string |
|
quarkus.rest-client."client".proxy-address
A string value in the form of : that specifies the HTTP proxy server hostname (or IP address) and port for requests of this client to use.
Use none to disable proxy
Environment variable: QUARKUS_REST_CLIENT__CLIENT__PROXY_ADDRESS
|
string |
|
quarkus.rest-client."client".proxy-user
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__PROXY_USER
|
string |
|
quarkus.rest-client."client".proxy-password
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__PROXY_PASSWORD
|
string |
|
quarkus.rest-client."client".non-proxy-hosts
Hosts to access without proxy
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__NON_PROXY_HOSTS
|
string |
|
quarkus.rest-client."client".query-param-style
An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED", or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__QUERY_PARAM_STYLE
|
multi-pairs , comma-separated , array-pairs
|
|
quarkus.rest-client."client".verify-host
Set whether hostname verification is enabled. Default is enabled. This setting should not be disabled in production as it makes the client vulnerable to MITM attacks.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__VERIFY_HOST
|
boolean |
|
quarkus.rest-client."client".trust-store
The trust store location. Can point to either a classpath resource or a file.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__TRUST_STORE
|
string |
|
quarkus.rest-client."client".trust-store-password
The trust store password.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__TRUST_STORE_PASSWORD
|
string |
|
quarkus.rest-client."client".trust-store-type
The type of the trust store. Defaults to "JKS".
Environment variable: QUARKUS_REST_CLIENT__CLIENT__TRUST_STORE_TYPE
|
string |
|
quarkus.rest-client."client".key-store
The key store location. Can point to either a classpath resource or a file.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__KEY_STORE
|
string |
|
quarkus.rest-client."client".key-store-password
Environment variable: QUARKUS_REST_CLIENT__CLIENT__KEY_STORE_PASSWORD
|
string |
|
quarkus.rest-client."client".key-store-type
The type of the key store. Defaults to "JKS".
Environment variable: QUARKUS_REST_CLIENT__CLIENT__KEY_STORE_TYPE
|
string |
|
quarkus.rest-client."client".hostname-verifier
The class name of the host name verifier. The class must have a public no-argument constructor.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__HOSTNAME_VERIFIER
|
string |
|
quarkus.rest-client."client".tls-configuration-name
The name of the TLS configuration to use.
If not set and the default TLS configuration is configured (quarkus.tls.* ) then that will be used. If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
If no TLS configuration is set, then the keys-tore, trust-store, etc. properties will be used.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__TLS_CONFIGURATION_NAME
|
string |
|
quarkus.rest-client."client".connection-ttl
The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of 0 means there is no timeout.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__CONNECTION_TTL
|
int |
|
quarkus.rest-client."client".connection-pool-size
The size of the connection pool for this client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__CONNECTION_POOL_SIZE
|
int |
|
quarkus.rest-client."client".keep-alive-enabled
If set to false disables the keep alive completely.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__KEEP_ALIVE_ENABLED
|
boolean |
|
quarkus.rest-client."client".max-redirects
The maximum number of redirection a request can follow.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__MAX_REDIRECTS
|
int |
|
quarkus.rest-client."client".headers."header-name"
The HTTP headers that should be applied to all requests of the rest client.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__HEADERS__HEADER_NAME_
|
Map<String,String> |
|
quarkus.rest-client."client".shared
Set to true to share the HTTP client between REST clients. There can be multiple shared clients distinguished by name, when no specific name is set, the name __vertx.DEFAULT is used.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__SHARED
|
boolean |
|
quarkus.rest-client."client".name
Set the HTTP client name, used when the client is shared, otherwise ignored.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__NAME
|
string |
|
quarkus.rest-client."client".user-agent
Configure the HTTP user-agent header to use.
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__USER_AGENT
|
string |
|
quarkus.rest-client."client".http2
If this is true then HTTP/2 will be enabled.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__HTTP2
|
boolean |
|
quarkus.rest-client."client".max-chunk-size
The max HTTP ch unk size (8096 bytes by default).
This property is not applicable to the RESTEasy Client.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__MAX_CHUNK_SIZE
|
MemorySize |
8K
|
quarkus.rest-client."client".alpn
If the Application-Layer Protocol Negotiation is enabled, the client will negotiate which protocol to use over the protocols exposed by the server. By default, it will try to use HTTP/2 first and if it’s not enabled, it will use HTTP/1.1. When the property http2 is enabled, this flag will be automatically enabled.
Environment variable: QUARKUS_REST_CLIENT__CLIENT__ALPN
|
boolean |
|
quarkus.rest-client."client".capture-stacktrace
If true , the stacktrace of the invocation of the REST Client method is captured. This stacktrace will be used if the invocation throws an exception
Environment variable: QUARKUS_REST_CLIENT__CLIENT__CAPTURE_STACKTRACE
|
boolean |
|
REST Common |
Type |
Default |
Set this to define the application path that serves as the base URI for all JAX-RS resource URIs provided by @Path annotations when there are no @ApplicationPath annotations defined on Application classes.
This value is always resolved relative to quarkus.http.root-path .
Environment variable: QUARKUS_REST_PATH
|
string |
|
quarkus.rest.input-buffer-size
The amount of memory that can be used to buffer input before switching to blocking IO.
Environment variable: QUARKUS_REST_INPUT_BUFFER_SIZE
|
MemorySize |
10k
|
quarkus.rest.min-chunk-size
The size of the chunks of memory allocated when writing data.
This is a very advanced setting that should only be set if you understand exactly how it affects the output IO operations of the application.
Environment variable: QUARKUS_REST_MIN_CHUNK_SIZE
|
int |
128
|
quarkus.rest.output-buffer-size
The size of the output stream response buffer. If a response is larger than this and no content-length is provided then the request will be chunked.
Larger values may give slight performance increases for large responses, at the expense of more memory usage.
Environment variable: QUARKUS_REST_OUTPUT_BUFFER_SIZE
|
int |
8191
|
quarkus.rest.single-default-produces
By default, we assume a default produced media type of "text/plain" for String endpoint return types. If this is disabled, the default produced media type will be "[text/plain, */*]" which is more expensive due to negotiation.
Environment variable: QUARKUS_REST_SINGLE_DEFAULT_PRODUCES
|
boolean |
true
|
quarkus.rest.default-produces
When one of the quarkus-rest-jackson or quarkus-rest-jsonb extension are active and the result type of an endpoint is an application class or one of Collection , List , Set or Map , we assume the default return type is "application/json" if this configuration is enabled.
Environment variable: QUARKUS_REST_DEFAULT_PRODUCES
|
boolean |
true
|
quarkus.rest.build-time-condition-aware
Whether annotations such @IfBuildTimeProfile , @IfBuildTimeProperty and friends will be taken into account when used on JAX-RS classes.
Environment variable: QUARKUS_REST_BUILD_TIME_CONDITION_AWARE
|
boolean |
true
|
quarkus.rest.fail-on-duplicate
Whether duplicate endpoints should trigger error at startup
Environment variable: QUARKUS_REST_FAIL_ON_DUPLICATE
|
boolean |
true
|
quarkus.rest.resume-on404
An advanced option that can be set when they RESTEasy Reactive should NOT reply with 404 when it does not match the URL path and instead just pass control onto the next Vert.x handler (if any)
Environment variable: QUARKUS_REST_RESUME_ON404
|
boolean |
false
|
quarkus.rest.multipart.input-part.default-charset
Environment variable: QUARKUS_REST_MULTIPART_INPUT_PART_DEFAULT_CHARSET
|
Charset |
UTF-8
|
quarkus.security.jaxrs.deny-unannotated-endpoints
if set to true, access to all JAX-RS resources will be denied by default
Environment variable: QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS
|
boolean |
false
|
quarkus.security.jaxrs.default-roles-allowed
If no security annotations are affecting a method then they will default to requiring these roles, (equivalent to adding an @RolesAllowed annotation with the roles to every endpoint class). The role of '**' means any authenticated user, which is equivalent to the io.quarkus.security.Authenticated annotation.
Environment variable: QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED
|
list of string |
|
REST Kotlin Serialization Common |
Type |
Default |
quarkus.kotlin-serialization.json.allow-special-floating-point-values
Removes JSON specification restriction on special floating-point values such as NaN and Infinity and enables their serialization and deserialization. When enabling it, please ensure that the receiving party will be able to encode and decode these special values.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_SPECIAL_FLOATING_POINT_VALUES
|
boolean |
false
|
quarkus.kotlin-serialization.json.allow-structured-map-keys
Enables structured objects to be serialized as map keys by changing serialized form of the map from JSON object (key-value pairs) to flat array like [k1, v1, k2, v2] .
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_STRUCTURED_MAP_KEYS
|
boolean |
false
|
quarkus.kotlin-serialization.json.class-discriminator
Name of the class descriptor property for polymorphic serialization.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_CLASS_DISCRIMINATOR
|
string |
type
|
quarkus.kotlin-serialization.json.coerce-input-values
Enables coercing incorrect JSON values to the default property value in the following cases: 1. JSON value is null but property type is non-nullable. 2. Property type is an enum type, but JSON value contains unknown enum member.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_COERCE_INPUT_VALUES
|
boolean |
false
|
quarkus.kotlin-serialization.json.encode-defaults
Specifies whether default values of Kotlin properties should be encoded.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_ENCODE_DEFAULTS
|
boolean |
true
|
quarkus.kotlin-serialization.json.explicit-nulls
Specifies whether null values should be encoded for nullable properties and must be present in JSON object during decoding.
When this flag is disabled properties with null values without default are not encoded; during decoding, the absence of a field value is treated as null for nullable properties without a default value.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_EXPLICIT_NULLS
|
boolean |
true
|
quarkus.kotlin-serialization.json.ignore-unknown-keys
Specifies whether encounters of unknown properties in the input JSON should be ignored instead of throwing [SerializationException].
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_IGNORE_UNKNOWN_KEYS
|
boolean |
false
|
quarkus.kotlin-serialization.json.is-lenient
Removes JSON specification restriction (RFC-4627) and makes parser more liberal to the malformed input. In lenient mode quoted boolean literals, and unquoted string literals are allowed.
Its relaxations can be expanded in the future, so that lenient parser becomes even more permissive to invalid value in the input, replacing them with defaults.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_IS_LENIENT
|
boolean |
false
|
quarkus.kotlin-serialization.json.pretty-print
Specifies whether resulting JSON should be pretty-printed.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT
|
boolean |
false
|
quarkus.kotlin-serialization.json.pretty-print-indent
Specifies indent string to use with [prettyPrint] mode
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_PRETTY_PRINT_INDENT
|
string |
` ` |
quarkus.kotlin-serialization.json.use-alternative-names
Specifies whether Json instance makes use of [JsonNames] annotation.
Disabling this flag when one does not use [JsonNames] at all may sometimes result in better performance, particularly when a large count of fields is skipped with [ignoreUnknownKeys].
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ALTERNATIVE_NAMES
|
boolean |
true
|
quarkus.kotlin-serialization.json.use-array-polymorphism
Switches polymorphic serialization to the default array format. This is an option for legacy JSON format and should not be generally used.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_USE_ARRAY_POLYMORPHISM
|
boolean |
false
|
quarkus.kotlin-serialization.json.naming-strategy
Specifies the JsonNamingStrategy that should be used for all properties in classes for serialization and deserialization. This strategy is applied for all entities that have StructureKind.CLASS .
This element can be one of two things:
-
the fully qualified class name of a type implements the NamingStrategy interface and has a no-arg constructor
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_NAMING_STRATEGY
|
string |
|
quarkus.kotlin-serialization.json.decode-enums-case-insensitive
Specifies if the enum values should be decoded case insensitively.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_DECODE_ENUMS_CASE_INSENSITIVE
|
boolean |
false
|
quarkus.kotlin-serialization.json.allow-trailing-comma
Specifies if trailing comma is allowed.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_TRAILING_COMMA
|
boolean |
false
|
quarkus.kotlin-serialization.json.allow-comments
Allows parser to accept C/Java-style comments in JSON input.
Environment variable: QUARKUS_KOTLIN_SERIALIZATION_JSON_ALLOW_COMMENTS
|
boolean |
false
|
RESTEasy Classic |
Type |
Default |
quarkus.security.jaxrs.deny-unannotated-endpoints
if set to true, access to all JAX-RS resources will be denied by default
Environment variable: QUARKUS_SECURITY_JAXRS_DENY_UNANNOTATED_ENDPOINTS
|
boolean |
false
|
quarkus.security.jaxrs.default-roles-allowed
If no security annotations are affecting a method then they will default to requiring these roles, (equivalent to adding an @RolesAllowed annotation with the roles to every endpoint class). The role of '**' means any authenticated user, which is equivalent to the io.quarkus.security.Authenticated annotation.
Environment variable: QUARKUS_SECURITY_JAXRS_DEFAULT_ROLES_ALLOWED
|
list of string |
|
quarkus.resteasy.vertx.response-buffer-size
The size of the output stream response buffer. If a response is larger than this and no content-length is provided then the request will be chunked. Larger values may give slight performance increases for large responses, at the expense of more memory usage.
Environment variable: QUARKUS_RESTEASY_VERTX_RESPONSE_BUFFER_SIZE
|
int |
8191
|
quarkus.resteasy.gzip.enabled
Environment variable: QUARKUS_RESTEASY_GZIP_ENABLED
|
boolean |
false
|
quarkus.resteasy.gzip.max-input
Maximum deflated file bytes size
If the limit is exceeded, Resteasy will return Response with status 413("Request Entity Too Large")
Environment variable: QUARKUS_RESTEASY_GZIP_MAX_INPUT
|
MemorySize |
10M
|
quarkus.resteasy-json.json-default
If this is true (the default) then JSON is set to the default media type. If a method has no produces/consumes and there is no builtin provider than can handle the type then we will assume the response should be JSON. Note that this will only take effect if a JSON provider has been installed, such as quarkus-resteasy-jsonb or quarkus-resteasy-jackson.
Environment variable: QUARKUS_RESTEASY_JSON_JSON_DEFAULT
|
boolean |
true
|
RESTEasy Classic - Server common |
Type |
Default |
quarkus.resteasy.singleton-resources
If this is true then JAX-RS will use only a single instance of a resource class to service all requests.
If this is false then it will create a new instance of the resource per request.
If the resource class has an explicit CDI scope annotation then the value of this annotation will always be used to control the lifecycle of the resource class.
IMPLEMENTATION NOTE: jakarta.ws.rs.Path turns into a CDI stereotype with singleton scope. As a result, if a user annotates a JAX-RS resource with a stereotype which has a different default scope the deployment fails with IllegalStateException.
Environment variable: QUARKUS_RESTEASY_SINGLETON_RESOURCES
|
boolean |
true
|
Set this to override the default path for JAX-RS resources if there are no annotated application classes. This path is specified with a leading / , but is resolved relative to quarkus.http.root-path .
-
If quarkus.http.root-path=/ and quarkus.resteasy.path=/bar , the JAX-RS resource path will be /bar
-
If quarkus.http.root-path=/foo and quarkus.resteasy.path=/bar , the JAX-RS resource path will be /foo/bar
Environment variable: QUARKUS_RESTEASY_PATH
|
string |
/
|
quarkus.resteasy.ignore-application-classes
Ignore all explicit JAX-RS Application classes. As multiple JAX-RS applications are not supported, this can be used to effectively merge all JAX-RS applications.
Environment variable: QUARKUS_RESTEASY_IGNORE_APPLICATION_CLASSES
|
boolean |
false
|
quarkus.resteasy.build-time-condition-aware
Whether annotations such @IfBuildTimeProfile , @IfBuildTimeProperty and friends will be taken into account when used on JAX-RS classes.
Environment variable: QUARKUS_RESTEASY_BUILD_TIME_CONDITION_AWARE
|
boolean |
true
|
RESTEasy Classic Multipart |
Type |
Default |
quarkus.resteasy.multipart.input-part.default-charset
Note that the default value is UTF-8 which is different from RESTEasy’s default value US-ASCII.
Environment variable: QUARKUS_RESTEASY_MULTIPART_INPUT_PART_DEFAULT_CHARSET
|
Charset |
UTF-8
|
quarkus.resteasy.multipart.input-part.default-content-type
The default content-type.
Environment variable: QUARKUS_RESTEASY_MULTIPART_INPUT_PART_DEFAULT_CONTENT_TYPE
|
string |
text/plain
|
RESTEasy Client - OpenID Connect Filter |
Type |
Default |
quarkus.resteasy-client-oidc-filter.register-filter
Enable OidcClientRequestFilter for all the injected MP RestClient implementations. If this property is disabled then OidcClientRequestFilter has to be registered as an MP RestClient provider.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_FILTER_REGISTER_FILTER
|
boolean |
false
|
quarkus.resteasy-client-oidc-filter.client-name
Name of the configured OidcClient used by the OidcClientRequestFilter. You can override this configuration for individual MP RestClient with the io.quarkus.oidc.client.filter.OidcClientFilter annotation.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_FILTER_CLIENT_NAME
|
string |
|
RESTEasy Client - OpenID Connect Token Propagation |
Type |
Default |
quarkus.resteasy-client-oidc-token-propagation.enabled
If the OIDC Token Propagation is enabled.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED
|
boolean |
true
|
quarkus.resteasy-client-oidc-token-propagation.enabled-during-authentication
Whether the token propagation is enabled during the SecurityIdentity augmentation.
For example, you may need to use a REST client from SecurityIdentityAugmentor
to propagate the current token to acquire additional roles for the SecurityIdentity .
Note, this feature relies on a duplicated context. More information about Vert.x duplicated
context can be found in this guide.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_ENABLED_DURING_AUTHENTICATION
|
boolean |
false
|
quarkus.resteasy-client-oidc-token-propagation.register-filter
Enable either AccessTokenRequestFilter or JsonWebTokenRequestFilter for all the injected MP RestClient implementations. AccessTokenRequestFilter can propagate both opaque (binary) and JsonWebToken tokens but it can not modify and secure the updated JsonWebToken tokens. JsonWebTokenRequestFilter can only propagate JsonWebToken tokens but it can also modify and secure them again. Enable the 'jsonWebToken' property to have JsonWebTokenRequestFilter registered. Alternatively, instead of using this property for registering these filters with all the injected MP RestClient implementations, both filters can be registered as MP RestClient providers with the specific MP RestClient implementations.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_REGISTER_FILTER
|
boolean |
false
|
quarkus.resteasy-client-oidc-token-propagation.json-web-token
Enable JsonWebTokenRequestFilter instead of AccessTokenRequestFilter for all the injected MP RestClient implementations. This filter can propagate as well as modify and secure the updated JsonWebToken tokens. Note this property is ignored unless the 'registerFilter' property is enabled.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_JSON_WEB_TOKEN
|
boolean |
false
|
quarkus.resteasy-client-oidc-token-propagation.secure-json-web-token
Secure the injected and possibly modified JsonWebToken. For example, a JsonWebToken produced and signed by OpenId Connect provider can be re-signed using a new private key. Note this property is injected into JsonWebTokenRequestFilter.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_SECURE_JSON_WEB_TOKEN
|
boolean |
false
|
quarkus.resteasy-client-oidc-token-propagation.exchange-token
Exchange the current token with OpenId Connect Provider for a new token using either "urn:ietf:params:oauth:grant-type:token-exchange" or "urn:ietf:params:oauth:grant-type:jwt-bearer" token grant before propagating it. Note this property is injected into AccessTokenRequestFilter.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_EXCHANGE_TOKEN
|
boolean |
false
|
quarkus.resteasy-client-oidc-token-propagation.client-name
Name of the configured OidcClient. Note this property is injected into AccessTokenRequestFilter and is only used if the exchangeToken property is enabled.
Environment variable: QUARKUS_RESTEASY_CLIENT_OIDC_TOKEN_PROPAGATION_CLIENT_NAME
|
string |
|
Scheduler |
Type |
Default |
quarkus.scheduler.cron-type
The syntax used in CRON expressions.
Environment variable: QUARKUS_SCHEDULER_CRON_TYPE
|
cron4j , quartz , unix , spring , spring53
|
quartz
|
quarkus.scheduler.metrics.enabled
Scheduled task metrics will be enabled if a metrics extension is present and this value is true.
Environment variable: QUARKUS_SCHEDULER_METRICS_ENABLED
|
boolean |
false
|
quarkus.scheduler.tracing.enabled
Controls whether tracing is enabled. If set to true and the OpenTelemetry extension is present, tracing will be enabled, creating automatic Spans for each scheduled task.
Environment variable: QUARKUS_SCHEDULER_TRACING_ENABLED
|
boolean |
false
|
quarkus.scheduler.use-composite-scheduler
By default, only one Scheduler implementation is used. If set to true then a composite Scheduler that delegates to all running implementations is used.
Scheduler implementations will be started depending on the value of quarkus.scheduler.start-mode , i.e. the scheduler is not started unless a relevant io.quarkus.scheduler.Scheduled business method is found.
Environment variable: QUARKUS_SCHEDULER_USE_COMPOSITE_SCHEDULER
|
boolean |
false
|
quarkus.scheduler.enabled
If schedulers are enabled.
Environment variable: QUARKUS_SCHEDULER_ENABLED
|
boolean |
true
|
quarkus.scheduler.overdue-grace-period
Scheduled task will be flagged as overdue if next execution time is exceeded by this period.
Environment variable: QUARKUS_SCHEDULER_OVERDUE_GRACE_PERIOD
|
Duration |
1S
|
quarkus.scheduler.start-mode
Scheduler can be started in different modes. By default, the scheduler is not started unless a io.quarkus.scheduler.Scheduled business method is found.
Environment variable: QUARKUS_SCHEDULER_START_MODE
|
|
|
Schema Registry - DevService |
Type |
Default |
Dev Services |
Type |
Default |
quarkus.apicurio-registry.devservices.enabled
If Dev Services for Apicurio Registry has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Apicurio Registry, Dev Services starts a registry unless mp.messaging.connector.smallrye-kafka.apicurio.registry.url or mp.messaging.connector.smallrye-kafka.schema.registry.url is set.
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_ENABLED
|
boolean |
|
quarkus.apicurio-registry.devservices.port
Optional fixed port the dev service will listen to.
If not defined, the port will be chosen randomly.
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_PORT
|
int |
|
quarkus.apicurio-registry.devservices.image-name
The Apicurio Registry image to use. Note that only Apicurio Registry 2.x images are supported. Specifically, the image repository must end with apicurio/apicurio-registry-mem .
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_IMAGE_NAME
|
string |
quay.io/apicurio/apicurio-registry-mem:2.4.2.Final
|
quarkus.apicurio-registry.devservices.shared
Indicates if the Apicurio Registry instance 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 Apicurio Registry starts a new container.
The discovery uses the quarkus-dev-service-apicurio-registry label. The value is configured using the service-name property.
Container sharing is only used in dev mode.
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_SHARED
|
boolean |
true
|
quarkus.apicurio-registry.devservices.service-name
The value of the quarkus-dev-service-apicurio-registry 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 Apicurio Registry looks for a container with the quarkus-dev-service-apicurio-registry 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-apicurio-registry label set to the specified value.
This property is used when you need multiple shared Apicurio Registry instances.
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_SERVICE_NAME
|
string |
apicurio-registry
|
quarkus.apicurio-registry.devservices.container-env."environment-variable-name"
Environment variables that are passed to the container.
Environment variable: QUARKUS_APICURIO_REGISTRY_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_
|
Map<String,String> |
|
Security |
Type |
Default |
quarkus.security.auth.enabled-in-dev-mode
Whether authorization is enabled in dev mode or not. In other launch modes authorization is always enabled.
Environment variable: QUARKUS_SECURITY_AUTH_ENABLED_IN_DEV_MODE
|
boolean |
true
|
quarkus.security.security-providers
List of security providers to register
Environment variable: QUARKUS_SECURITY_SECURITY_PROVIDERS
|
list of string |
|
quarkus.security.security-provider-config."provider-name"
Security provider configuration
Environment variable: QUARKUS_SECURITY_SECURITY_PROVIDER_CONFIG__PROVIDER_NAME_
|
Map<String,String> |
|
quarkus.security.deny-unannotated-members
If set to true, access to all methods of beans that have any security annotations on other members will be denied by default. E.g. if enabled, in the following bean, methodB will be denied.
@ApplicationScoped
public class A {
@RolesAllowed("admin")
public void methodA() {
...
}
public void methodB() {
...
}
}
Environment variable: QUARKUS_SECURITY_DENY_UNANNOTATED_MEMBERS
|
boolean |
false
|
quarkus.security.events.enabled
Whether security events should be fired.
Environment variable: QUARKUS_SECURITY_EVENTS_ENABLED
|
boolean |
true
|
Security Jakarta Persistence |
Type |
Default |
quarkus.security-jpa.persistence-unit-name
Selects the Hibernate ORM persistence unit. Default persistence unit is used when no value is specified.
Environment variable: QUARKUS_SECURITY_JPA_PERSISTENCE_UNIT_NAME
|
string |
<default>
|
Security WebAuthn |
Type |
Default |
If the WebAuthn extension is enabled.
Environment variable: QUARKUS_WEBAUTHN_ENABLED
|
boolean |
true
|
Environment variable: QUARKUS_WEBAUTHN_ORIGIN
|
string |
|
quarkus.webauthn.transports
Authenticator Transports allowed by the application. Authenticators can interact with the user web browser through several transports. Applications may want to restrict the transport protocols for extra security hardening reasons. By default, all transports should be allowed. If your application is to be used by mobile phone users, you may want to restrict only the INTERNAL authenticator to be allowed. Permitted values are:
-
USB - USB connected authenticators (e.g.: Yubikey’s)
-
NFC - NFC connected authenticators (e.g.: Yubikey’s)
-
BLE - Bluetooth LE connected authenticators
-
INTERNAL - Hardware security chips (e.g.: Intel TPM2.0)
Environment variable: QUARKUS_WEBAUTHN_TRANSPORTS
|
list of usb , nfc , ble , internal
|
USB,NFC,BLE,INTERNAL
|
quarkus.webauthn.relying-party.id
The id (or domain name of your server)
Environment variable: QUARKUS_WEBAUTHN_RELYING_PARTY_ID
|
string |
|
quarkus.webauthn.relying-party.name
A user friendly name for your server
Environment variable: QUARKUS_WEBAUTHN_RELYING_PARTY_NAME
|
string |
Quarkus server
|
quarkus.webauthn.authenticator-attachment
Kind of Authenticator Attachment allowed. Authenticators can connect to your device in two forms:
-
PLATFORM - The Authenticator is built-in to your device (e.g.: Security chip)
-
CROSS_PLATFORM - The Authenticator can roam across devices (e.g.: USB Authenticator) For security reasons your application may choose to restrict to a specific attachment mode. If omitted, then any mode is permitted.
Environment variable: QUARKUS_WEBAUTHN_AUTHENTICATOR_ATTACHMENT
|
|
|
quarkus.webauthn.require-resident-key
Resident key required. A resident (private) key, is a key that cannot leave your authenticator device, this means that you cannot reuse the authenticator to log into a second computer.
Environment variable: QUARKUS_WEBAUTHN_REQUIRE_RESIDENT_KEY
|
boolean |
false
|
quarkus.webauthn.user-verification
User Verification requirements. Webauthn applications may choose REQUIRED verification to assert that the user is present during the authentication ceremonies, but in some cases, applications may want to reduce the interactions with the user, i.e.: prevent the use of pop-ups. Valid values are:
-
REQUIRED - User must always interact with the browser
-
PREFERRED - User should always interact with the browser
-
DISCOURAGED - User should avoid interact with the browser
Environment variable: QUARKUS_WEBAUTHN_USER_VERIFICATION
|
required , preferred , discouraged
|
DISCOURAGED
|
Non-negative User Verification timeout. Authentication must occur within the timeout, this will prevent the user browser from being blocked with a pop-up required user verification, and the whole ceremony must be completed within the timeout period. After the timeout, any previously issued challenge is automatically invalidated.
Environment variable: QUARKUS_WEBAUTHN_TIMEOUT
|
Duration |
60s
|
quarkus.webauthn.attestation
Device Attestation Preference. During registration, applications may want to attest the device. Attestation is a cryptographic verification of the authenticator hardware. Attestation implies that the privacy of the users may be exposed and browsers might override the desired configuration on the user’s behalf. Valid values are:
-
NONE - no attestation data is sent with registration
-
INDIRECT - attestation data is sent with registration, yielding anonymized data by a trusted CA
-
DIRECT - attestation data is sent with registration
-
ENTERPRISE - no attestation data is sent with registration. The device AAGUID is returned unaltered.
Environment variable: QUARKUS_WEBAUTHN_ATTESTATION
|
none , indirect , direct , enterprise
|
NONE
|
quarkus.webauthn.pub-key-cred-params
Allowed Public Key Credential algorithms by preference order. Webauthn mandates that all authenticators must support at least the following 2 algorithms: ES256 and RS256 . Applications may require stronger keys and algorithms, for example: ES512 or EdDSA . Note that the use of stronger algorithms, e.g.: EdDSA may require Java 15 or a cryptographic JCE provider that implements the algorithms.
Environment variable: QUARKUS_WEBAUTHN_PUB_KEY_CRED_PARAMS
|
list of es256 , es384 , es512 , ps256 , ps384 , ps512 , es256k , rs256 , rs384 , rs512 , rs1 , ed-dsa
|
ES256,RS256
|
quarkus.webauthn.challenge-length
Length of the challenges exchanged between the application and the browser. Challenges must be at least 32 bytes.
Environment variable: QUARKUS_WEBAUTHN_CHALLENGE_LENGTH
|
int |
64
|
quarkus.webauthn.login-page
Environment variable: QUARKUS_WEBAUTHN_LOGIN_PAGE
|
string |
/login.html
|
quarkus.webauthn.session-timeout
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced.
Environment variable: QUARKUS_WEBAUTHN_SESSION_TIMEOUT
|
Duration |
PT30M
|
quarkus.webauthn.new-cookie-interval
How old a cookie can get before it will be replaced with a new cookie with an updated timeout, also referred to as "renewal-timeout". Note that smaller values will result in slightly more server load (as new encrypted cookies will be generated more often); however, larger values affect the inactivity timeout because the timeout is set when a cookie is generated. For example if this is set to 10 minutes, and the inactivity timeout is 30m, if a user’s last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request because the timeout is only refreshed when a new cookie is generated. That is, no timeout is tracked on the server side; the timestamp is encoded and encrypted in the cookie itself, and it is decrypted and parsed with each request.
Environment variable: QUARKUS_WEBAUTHN_NEW_COOKIE_INTERVAL
|
Duration |
PT1M
|
quarkus.webauthn.cookie-name
The cookie that is used to store the persistent session
Environment variable: QUARKUS_WEBAUTHN_COOKIE_NAME
|
string |
quarkus-credential
|
quarkus.webauthn.challenge-cookie-name
The cookie that is used to store the challenge data during login/registration
Environment variable: QUARKUS_WEBAUTHN_CHALLENGE_COOKIE_NAME
|
string |
_quarkus_webauthn_challenge
|
quarkus.webauthn.challenge-username-cookie-name
The cookie that is used to store the username data during login/registration
Environment variable: QUARKUS_WEBAUTHN_CHALLENGE_USERNAME_COOKIE_NAME
|
string |
_quarkus_webauthn_username
|
quarkus.webauthn.cookie-same-site
SameSite attribute for the session cookie.
Environment variable: QUARKUS_WEBAUTHN_COOKIE_SAME_SITE
|
|
strict
|
quarkus.webauthn.cookie-path
The cookie path for the session cookies.
Environment variable: QUARKUS_WEBAUTHN_COOKIE_PATH
|
string |
/
|
SmallRye GraphQL |
Type |
Default |
quarkus.smallrye-graphql.root-path
The rootPath under which queries will be served. Default to graphql By default, this value will be resolved as a path relative to ${quarkus.http.root-path} .
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_ROOT_PATH
|
string |
graphql
|
quarkus.smallrye-graphql.federation.enabled
Enable Apollo Federation. If this value is unspecified, then federation will be enabled automatically if any GraphQL Federation annotations are detected in the application.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_FEDERATION_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.federation.batch-resolving-enabled
Enable batch resolving for federation. Disabled by default.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_FEDERATION_BATCH_RESOLVING_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.metrics.enabled
Enable metrics. By default, this is false. If set to true, a metrics extension is required.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_METRICS_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.tracing.enabled
Enable tracing. By default, this will be enabled if the tracing extension is added.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_TRACING_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.events.enabled
Enable eventing. Allow you to receive events on bootstrap and execution.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_EVENTS_ENABLED
|
boolean |
false
|
quarkus.smallrye-graphql.nonblocking.enabled
Enable non-blocking support. Default is true.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_NONBLOCKING_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.http.get.enabled
Enable GET Requests. Allow queries via HTTP GET.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_HTTP_GET_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.http.post.queryparameters.enabled
Enable Query parameter on POST Requests. Allow POST request to override or supply values in a query parameter.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_HTTP_POST_QUERYPARAMETERS_ENABLED
|
boolean |
|
quarkus.smallrye-graphql.auto-name-strategy
Change the type naming strategy. All possible strategies are: default, merge-inner-class, full
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_AUTO_NAME_STRATEGY
|
string |
Default
|
quarkus.smallrye-graphql.error-extension-fields
List of extension fields that should be included in the error response. By default, none will be included. Examples of valid values include [exception,classification,code,description,validationErrorType,queryPath]
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_ERROR_EXTENSION_FIELDS
|
list of string |
|
quarkus.smallrye-graphql.show-runtime-exception-message
List of Runtime Exceptions class names that should show the error message. By default, Runtime Exception messages will be hidden and a generic Server Error message will be returned.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SHOW_RUNTIME_EXCEPTION_MESSAGE
|
list of string |
|
quarkus.smallrye-graphql.hide-checked-exception-message
List of Checked Exceptions class names that should hide the error message. By default, Checked Exception messages will show the exception message.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_HIDE_CHECKED_EXCEPTION_MESSAGE
|
list of string |
|
quarkus.smallrye-graphql.default-error-message
The default error message that will be used for hidden exception messages. Defaults to "Server Error"
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_DEFAULT_ERROR_MESSAGE
|
string |
|
quarkus.smallrye-graphql.print-data-fetcher-exception
Print the data fetcher exception to the log file. Default true in dev and test mode, default false in prod.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PRINT_DATA_FETCHER_EXCEPTION
|
boolean |
|
quarkus.smallrye-graphql.schema-available
Make the schema available over HTTP.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SCHEMA_AVAILABLE
|
boolean |
true
|
quarkus.smallrye-graphql.schema-include-scalars
Include the Scalar definitions in the schema.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SCHEMA_INCLUDE_SCALARS
|
boolean |
false
|
quarkus.smallrye-graphql.schema-include-schema-definition
Include the schema internal definition in the schema.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SCHEMA_INCLUDE_SCHEMA_DEFINITION
|
boolean |
false
|
quarkus.smallrye-graphql.schema-include-directives
Include Directives in the schema.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SCHEMA_INCLUDE_DIRECTIVES
|
boolean |
false
|
quarkus.smallrye-graphql.schema-include-introspection-types
Include Introspection Types in the schema.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_SCHEMA_INCLUDE_INTROSPECTION_TYPES
|
boolean |
false
|
quarkus.smallrye-graphql.log-payload
Log the payload (and optionally variables) to System out.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_LOG_PAYLOAD
|
off , query-only , query-and-variables
|
off
|
quarkus.smallrye-graphql.field-visibility
Set the Field visibility.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_FIELD_VISIBILITY
|
string |
default
|
quarkus.smallrye-graphql.unwrap-exceptions
Exceptions that should be unwrapped (class names).
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_UNWRAP_EXCEPTIONS
|
list of string |
|
quarkus.smallrye-graphql.websocket-subprotocols
Subprotocols that should be supported by the server for graphql-over-websocket use cases. Allowed subprotocols are "graphql-ws" and "graphql-transport-ws". By default, both are enabled.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_WEBSOCKET_SUBPROTOCOLS
|
list of string |
|
quarkus.smallrye-graphql.parser-capture-ignored-chars
Set to true if ignored chars should be captured as AST nodes. Default to false
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PARSER_CAPTURE_IGNORED_CHARS
|
boolean |
|
quarkus.smallrye-graphql.parser-capture-line-comments
Set to true if `graphql.language.Comment`s should be captured as AST nodes
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PARSER_CAPTURE_LINE_COMMENTS
|
boolean |
|
quarkus.smallrye-graphql.parser-capture-source-location
Set to true true if `graphql.language.SourceLocation`s should be captured as AST nodes. Default to true
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PARSER_CAPTURE_SOURCE_LOCATION
|
boolean |
|
quarkus.smallrye-graphql.parser-max-tokens
The maximum number of raw tokens the parser will accept, after which an exception will be thrown. Default to 15000
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PARSER_MAX_TOKENS
|
int |
|
quarkus.smallrye-graphql.parser-max-whitespace-tokens
The maximum number of raw whitespace tokens the parser will accept, after which an exception will be thrown. Default to 200000
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_PARSER_MAX_WHITESPACE_TOKENS
|
int |
|
quarkus.smallrye-graphql.instrumentation-query-complexity
Abort a query if the total number of data fields queried exceeds the defined limit. Default to no limit
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_INSTRUMENTATION_QUERY_COMPLEXITY
|
int |
|
quarkus.smallrye-graphql.instrumentation-query-depth
Abort a query if the total depth of the query exceeds the defined limit. Default to no limit
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_INSTRUMENTATION_QUERY_DEPTH
|
int |
|
quarkus.smallrye-graphql.extra-scalars
Additional scalars to register in the schema. These are taken from the graphql-java-extended-scalars library.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_EXTRA_SCALARS
|
|
|
quarkus.smallrye-graphql.exclude-null-fields-in-responses
Excludes all the 'null' fields in the GraphQL response’s data field, except for the non-successfully resolved fields (errors). Disabled by default.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_EXCLUDE_NULL_FIELDS_IN_RESPONSES
|
boolean |
|
quarkus.smallrye-graphql.ui.enable
If GraphQL UI should be enabled. By default, GraphQL UI is enabled if it is included (see always-include ).
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_UI_ENABLE
|
boolean |
true
|
SmallRye GraphQL UI configuration |
Type |
Default |
quarkus.smallrye-graphql.ui.root-path
The path where GraphQL UI is available. The value / is not allowed as it blocks the application from serving anything else. By default, this URL will be resolved as a path relative to ${quarkus.http.non-application-root-path} .
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_UI_ROOT_PATH
|
string |
graphql-ui
|
quarkus.smallrye-graphql.ui.always-include
Always include the UI. By default, this will only be included in dev and test. Setting this to true will also include the UI in Prod
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_UI_ALWAYS_INCLUDE
|
boolean |
false
|
SmallRye GraphQL Client |
Type |
Default |
quarkus.smallrye-graphql-client.enable-build-time-scanning
Configuration item to enable build-time scanning in Quarkus for generating typesafe GraphQL client models. If true, build-time scanning is enabled. By default, it is true.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT_ENABLE_BUILD_TIME_SCANNING
|
boolean |
true
|
quarkus.smallrye-graphql-client."clients".url
The URL location of the target GraphQL service.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__URL
|
string |
|
quarkus.smallrye-graphql-client."clients".header."header-name"
HTTP headers to add when communicating with the target GraphQL service.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__HEADER__HEADER_NAME_
|
Map<String,String> |
|
quarkus.smallrye-graphql-client."clients".subprotocols
WebSocket subprotocols that should be supported by this client for running GraphQL operations over websockets. Allowed values are: - graphql-ws for the deprecated Apollo protocol - graphql-transport-ws for the newer GraphQL over WebSocket protocol (default value) If multiple protocols are provided, the actual protocol to be used will be subject to negotiation with the server.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__SUBPROTOCOLS
|
list of string |
graphql-transport-ws
|
quarkus.smallrye-graphql-client."clients".execute-single-result-operations-over-websocket
If true, then queries and mutations will run over the websocket transport rather than pure HTTP. Off by default, because it has higher overhead.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__EXECUTE_SINGLE_RESULT_OPERATIONS_OVER_WEBSOCKET
|
boolean |
|
quarkus.smallrye-graphql-client."clients".websocket-initialization-timeout
Maximum time in milliseconds that will be allowed to wait for the server to acknowledge a websocket connection (send a subprotocol-specific ACK message).
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__WEBSOCKET_INITIALIZATION_TIMEOUT
|
int |
|
quarkus.smallrye-graphql-client."clients".trust-store
The trust store location. Can point to either a classpath resource or a file.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE
|
string |
|
quarkus.smallrye-graphql-client."clients".trust-store-password
The trust store password.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_PASSWORD
|
string |
|
quarkus.smallrye-graphql-client."clients".trust-store-type
The type of the trust store. Defaults to "JKS".
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__TRUST_STORE_TYPE
|
string |
|
quarkus.smallrye-graphql-client."clients".key-store
The key store location. Can point to either a classpath resource or a file.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE
|
string |
|
quarkus.smallrye-graphql-client."clients".key-store-password
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_PASSWORD
|
string |
|
quarkus.smallrye-graphql-client."clients".key-store-type
The type of the key store. Defaults to "JKS".
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__KEY_STORE_TYPE
|
string |
|
quarkus.smallrye-graphql-client."clients".proxy-host
Hostname of the proxy to use.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__PROXY_HOST
|
string |
|
quarkus.smallrye-graphql-client."clients".proxy-port
Port number of the proxy to use.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__PROXY_PORT
|
int |
|
quarkus.smallrye-graphql-client."clients".proxy-username
Username for the proxy to use.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__PROXY_USERNAME
|
string |
|
quarkus.smallrye-graphql-client."clients".proxy-password
Password for the proxy to use.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__PROXY_PASSWORD
|
string |
|
quarkus.smallrye-graphql-client."clients".max-redirects
Maximum number of redirects to follow.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__MAX_REDIRECTS
|
int |
|
quarkus.smallrye-graphql-client."clients".init-payload."property-name"
Additional payload sent on websocket initialization.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__INIT_PAYLOAD__PROPERTY_NAME_
|
Map<String,String> |
|
quarkus.smallrye-graphql-client."clients".allow-unexpected-response-fields
Allowing unexpected fields in response. If true, there will be warning log of an unexpected field. Else it throws an error.
Environment variable: QUARKUS_SMALLRYE_GRAPHQL_CLIENT__CLIENTS__ALLOW_UNEXPECTED_RESPONSE_FIELDS
|
boolean |
|
SmallRye Health |
Type |
Default |
quarkus.smallrye-health.enabled
Activate or disable this extension. Disabling this extension means that no health related information is exposed.
Environment variable: QUARKUS_SMALLRYE_HEALTH_ENABLED
|
boolean |
true
|
quarkus.smallrye-health.extensions.enabled
Whether extensions published health check should be enabled.
Environment variable: QUARKUS_SMALLRYE_HEALTH_EXTENSIONS_ENABLED
|
boolean |
true
|
quarkus.smallrye-health.openapi.included
Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document
Environment variable: QUARKUS_SMALLRYE_HEALTH_OPENAPI_INCLUDED
|
boolean |
false
|
quarkus.smallrye-health.root-path
Root path for health-checking endpoints. By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path} . If the management interface is enabled, the value will be resolved as a path relative to ${quarkus.management.root-path} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_ROOT_PATH
|
string |
health
|
quarkus.smallrye-health.liveness-path
The relative path of the liveness health-checking endpoint. By default, this value will be resolved as a path relative to ${quarkus.smallrye-health.rootPath} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_LIVENESS_PATH
|
string |
live
|
quarkus.smallrye-health.readiness-path
The relative path of the readiness health-checking endpoint. By default, this value will be resolved as a path relative to ${quarkus.smallrye-health.rootPath} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_READINESS_PATH
|
string |
ready
|
quarkus.smallrye-health.group-path
The relative path of the health group endpoint. By default, this value will be resolved as a path relative to ${quarkus.smallrye-health.rootPath} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_GROUP_PATH
|
string |
group
|
quarkus.smallrye-health.wellness-path
The relative path of the wellness health-checking endpoint. By default, this value will be resolved as a path relative to ${quarkus.smallrye-health.rootPath} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_WELLNESS_PATH
|
string |
well
|
quarkus.smallrye-health.startup-path
The relative path of the startup health-checking endpoint. By default, this value will be resolved as a path relative to ${quarkus.smallrye-health.rootPath} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_STARTUP_PATH
|
string |
started
|
quarkus.smallrye-health.context-propagation
Whether the context should be propagated to each health check invocation.
Environment variable: QUARKUS_SMALLRYE_HEALTH_CONTEXT_PROPAGATION
|
boolean |
false
|
quarkus.smallrye-health.max-group-registries-count
The number of the maximum health groups that can be created.
Environment variable: QUARKUS_SMALLRYE_HEALTH_MAX_GROUP_REGISTRIES_COUNT
|
int |
|
quarkus.smallrye-health.default-health-group
The name of the default health group used when no other health group is defined on the health check.
Environment variable: QUARKUS_SMALLRYE_HEALTH_DEFAULT_HEALTH_GROUP
|
string |
|
quarkus.smallrye-health.management.enabled
If management interface is turned on the health endpoints and ui will be published under the management interface. This allows you to exclude Health from management by setting the value to false
Environment variable: QUARKUS_SMALLRYE_HEALTH_MANAGEMENT_ENABLED
|
boolean |
true
|
quarkus.smallrye-health.ui.enable
If Health UI should be enabled. By default, Health UI is enabled if it is included (see always-include ).
Environment variable: QUARKUS_SMALLRYE_HEALTH_UI_ENABLE
|
boolean |
true
|
quarkus.smallrye-health.additional.property."property-name"
Additional top-level properties to be included in the resulting JSON object.
Environment variable: QUARKUS_SMALLRYE_HEALTH_ADDITIONAL_PROPERTY__PROPERTY_NAME_
|
Map<String,String> |
|
quarkus.smallrye-health.check."check-name".enabled
Whether the HealthCheck should be enabled.
Environment variable: QUARKUS_SMALLRYE_HEALTH_CHECK__CHECK_NAME__ENABLED
|
boolean |
false
|
SmallRye Health UI configuration |
Type |
Default |
quarkus.smallrye-health.ui.root-path
The path where Health UI is available. The value / is not allowed as it blocks the application from serving anything else. By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path} .
Environment variable: QUARKUS_SMALLRYE_HEALTH_UI_ROOT_PATH
|
string |
health-ui
|
quarkus.smallrye-health.ui.always-include
Always include the UI. By default, this will only be included in dev and test. Setting this to true will also include the UI in Prod
Environment variable: QUARKUS_SMALLRYE_HEALTH_UI_ALWAYS_INCLUDE
|
boolean |
false
|
SmallRye JWT |
Type |
Default |
quarkus.smallrye-jwt.enabled
The MP-JWT configuration object
Environment variable: QUARKUS_SMALLRYE_JWT_ENABLED
|
boolean |
true
|
quarkus.smallrye-jwt.rsa-sig-provider
The name of the java.security.Provider that supports SHA256withRSA signatures
Environment variable: QUARKUS_SMALLRYE_JWT_RSA_SIG_PROVIDER
|
string |
SunRsaSign
|
quarkus.smallrye-jwt.blocking-authentication
Enable this property if fetching the remote keys can be a time-consuming operation. Do not enable it if you use the local keys.
Environment variable: QUARKUS_SMALLRYE_JWT_BLOCKING_AUTHENTICATION
|
boolean |
false
|
quarkus.smallrye-jwt.silent
Always create HTTP 401 challenge, even for requests containing no authentication credentials. JWT authentication mechanism will return HTTP 401 when an authentication challenge is required. However if it is used alongside one of the interactive authentication mechanisms then returning HTTP 401 to the users accessing the application from a browser may not be desired. If you prefer you can request that JWT authentication mechanism does not create a challenge in such cases by setting this property to 'true'.
Environment variable: QUARKUS_SMALLRYE_JWT_SILENT
|
boolean |
false
|
SmallRye Metrics |
Type |
Default |
quarkus.smallrye-metrics.path
The path to the metrics handler. By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path} . If the management interface is enabled, the value will be resolved as a path relative to ${quarkus.management.root-path} .
Environment variable: QUARKUS_SMALLRYE_METRICS_PATH
|
string |
metrics
|
quarkus.smallrye-metrics.extensions.enabled
Whether metrics published by Quarkus extensions should be enabled.
Environment variable: QUARKUS_SMALLRYE_METRICS_EXTENSIONS_ENABLED
|
boolean |
true
|
quarkus.smallrye-metrics.micrometer.compatibility
Apply Micrometer compatibility mode, where instead of regular 'base' and 'vendor' metrics, Quarkus exposes the same 'jvm' metrics that Micrometer does. Application metrics are unaffected by this mode. The use case is to facilitate migration from Micrometer-based metrics, because original dashboards for JVM metrics will continue working without having to rewrite them.
Environment variable: QUARKUS_SMALLRYE_METRICS_MICROMETER_COMPATIBILITY
|
boolean |
false
|
quarkus.smallrye-metrics.jaxrs.enabled
Whether detailed JAX-RS metrics should be enabled.
Environment variable: QUARKUS_SMALLRYE_METRICS_JAXRS_ENABLED
|
boolean |
false
|
SmallRye OpenAPI - Common |
Type |
Default |
quarkus.smallrye-openapi.path
The path at which to register the OpenAPI Servlet.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_PATH
|
string |
openapi
|
quarkus.smallrye-openapi.store-schema-directory
If set, the generated OpenAPI schema documents will be stored here on build. Both openapi.json and openapi.yaml will be stored here if this is set.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_STORE_SCHEMA_DIRECTORY
|
path |
|
quarkus.smallrye-openapi.always-run-filter
Do not run the filter only at startup, but every time the document is requested (dynamic).
Environment variable: QUARKUS_SMALLRYE_OPENAPI_ALWAYS_RUN_FILTER
|
boolean |
false
|
quarkus.smallrye-openapi.ignore-static-document
Do not include the provided static openapi document (eg. META-INF/openapi.yaml)
Environment variable: QUARKUS_SMALLRYE_OPENAPI_IGNORE_STATIC_DOCUMENT
|
boolean |
false
|
quarkus.smallrye-openapi.management.enabled
If management interface is turned on the openapi schema document will be published under the management interface. This allows you to exclude OpenAPI from management by setting the value to false
Environment variable: QUARKUS_SMALLRYE_OPENAPI_MANAGEMENT_ENABLED
|
boolean |
true
|
quarkus.smallrye-openapi.additional-docs-directory
A list of local directories that should be scanned for yaml and/or json files to be included in the static model. Example: META-INF/openapi/
Environment variable: QUARKUS_SMALLRYE_OPENAPI_ADDITIONAL_DOCS_DIRECTORY
|
list of path |
|
quarkus.smallrye-openapi.security-scheme
Add a certain SecurityScheme with config
Environment variable: QUARKUS_SMALLRYE_OPENAPI_SECURITY_SCHEME
|
api-key , basic , jwt , oauth2 , oidc , oauth2-implicit
|
|
quarkus.smallrye-openapi.security-scheme-name
Add a Security Scheme name to the generated OpenAPI document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_SECURITY_SCHEME_NAME
|
string |
SecurityScheme
|
quarkus.smallrye-openapi.security-scheme-description
Add a description to the Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_SECURITY_SCHEME_DESCRIPTION
|
string |
Authentication
|
quarkus.smallrye-openapi.security-scheme-extensions."extension-name"
Add one or more extensions to the security scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_SECURITY_SCHEME_EXTENSIONS__EXTENSION_NAME_
|
Map<String,String> |
|
quarkus.smallrye-openapi.auto-add-security-requirement
This will automatically add the security requirement to all methods/classes that has a RolesAllowed annotation.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_AUTO_ADD_SECURITY_REQUIREMENT
|
boolean |
true
|
quarkus.smallrye-openapi.auto-add-tags
This will automatically add tags to operations based on the Java class name.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_AUTO_ADD_TAGS
|
boolean |
true
|
quarkus.smallrye-openapi.auto-add-server
Setting it to true will automatically add a default server to the schema if none is provided, using the current running server host and port.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_AUTO_ADD_SERVER
|
boolean |
|
quarkus.smallrye-openapi.auto-add-security
This will automatically add security based on the security extension included (if any).
Environment variable: QUARKUS_SMALLRYE_OPENAPI_AUTO_ADD_SECURITY
|
boolean |
true
|
quarkus.smallrye-openapi.api-key-parameter-in
Required when using apiKey security. The location of the API key. Valid values are "query", "header" or "cookie".
Environment variable: QUARKUS_SMALLRYE_OPENAPI_API_KEY_PARAMETER_IN
|
string |
|
quarkus.smallrye-openapi.api-key-parameter-name
Required when using apiKey security. The name of the header, query or cookie parameter to be used.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_API_KEY_PARAMETER_NAME
|
string |
|
quarkus.smallrye-openapi.basic-security-scheme-value
Add a scheme value to the Basic HTTP Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_BASIC_SECURITY_SCHEME_VALUE
|
string |
basic
|
quarkus.smallrye-openapi.jwt-security-scheme-value
Add a scheme value to the JWT Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_JWT_SECURITY_SCHEME_VALUE
|
string |
bearer
|
quarkus.smallrye-openapi.jwt-bearer-format
Add a bearer format the JWT Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_JWT_BEARER_FORMAT
|
string |
JWT
|
quarkus.smallrye-openapi.oauth2-security-scheme-value
Add a scheme value to the OAuth2 opaque token Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OAUTH2_SECURITY_SCHEME_VALUE
|
string |
bearer
|
quarkus.smallrye-openapi.oauth2-bearer-format
Add a scheme value to OAuth2 opaque token Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OAUTH2_BEARER_FORMAT
|
string |
Opaque
|
quarkus.smallrye-openapi.oidc-open-id-connect-url
Add a openIdConnectUrl value to the OIDC Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OIDC_OPEN_ID_CONNECT_URL
|
string |
|
quarkus.smallrye-openapi.oauth2-implicit-refresh-url
Add a implicit flow refreshUrl value to the OAuth2 Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OAUTH2_IMPLICIT_REFRESH_URL
|
string |
|
quarkus.smallrye-openapi.oauth2-implicit-authorization-url
Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OAUTH2_IMPLICIT_AUTHORIZATION_URL
|
string |
|
quarkus.smallrye-openapi.oauth2-implicit-token-url
Add an implicit flow tokenUrl value to the OAuth2 Security Scheme
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OAUTH2_IMPLICIT_TOKEN_URL
|
string |
|
quarkus.smallrye-openapi.open-api-version
Override the openapi version in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OPEN_API_VERSION
|
string |
|
quarkus.smallrye-openapi.info-title
Set the title in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_TITLE
|
string |
|
quarkus.smallrye-openapi.info-version
Set the version in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_VERSION
|
string |
|
quarkus.smallrye-openapi.info-description
Set the description in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_DESCRIPTION
|
string |
|
quarkus.smallrye-openapi.info-terms-of-service
Set the terms of the service in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_TERMS_OF_SERVICE
|
string |
|
quarkus.smallrye-openapi.info-contact-email
Set the contact email in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_CONTACT_EMAIL
|
string |
|
quarkus.smallrye-openapi.info-contact-name
Set the contact name in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_CONTACT_NAME
|
string |
|
quarkus.smallrye-openapi.info-contact-url
Set the contact url in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_CONTACT_URL
|
string |
|
quarkus.smallrye-openapi.info-license-name
Set the license name in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_LICENSE_NAME
|
string |
|
quarkus.smallrye-openapi.info-license-url
Set the license url in Info tag in the Schema document
Environment variable: QUARKUS_SMALLRYE_OPENAPI_INFO_LICENSE_URL
|
string |
|
quarkus.smallrye-openapi.operation-id-strategy
Set the strategy to automatically create an operation Id
Environment variable: QUARKUS_SMALLRYE_OPENAPI_OPERATION_ID_STRATEGY
|
method , class-method , package-class-method
|
|
quarkus.smallrye-openapi.enable
Enable the openapi endpoint. By default it’s enabled.
Environment variable: QUARKUS_SMALLRYE_OPENAPI_ENABLE
|
boolean |
true
|
quarkus.smallrye-openapi.servers
Specify the list of global servers that provide connectivity information
Environment variable: QUARKUS_SMALLRYE_OPENAPI_SERVERS
|
list of string |
|
SmallRye Stork |
Type |
Default |
Configuration for the service |
Type |
Default |
quarkus.stork."service-name".service-discovery.type
Configures the service discovery type, e.g. "consul". ServiceDiscoveryProvider for the type has to be available
Environment variable: QUARKUS_STORK__SERVICE_NAME__SERVICE_DISCOVERY_TYPE
|
string |
required |
quarkus.stork."service-name".service-discovery."params"
ServiceDiscovery parameters. Check the documentation of the selected service discovery type for available parameters.
Environment variable: QUARKUS_STORK__SERVICE_NAME__SERVICE_DISCOVERY__PARAMS_
|
Map<String,String> |
|
quarkus.stork."service-name".load-balancer.type
Configures load balancer type, e.g. "round-robin". A LoadBalancerProvider for the type has to be available
Environment variable: QUARKUS_STORK__SERVICE_NAME__LOAD_BALANCER_TYPE
|
string |
round-robin
|
quarkus.stork."service-name".load-balancer."parameters"
Load Balancer parameters. Check the documentation of the selected load balancer type for available parameters
Environment variable: QUARKUS_STORK__SERVICE_NAME__LOAD_BALANCER__PARAMETERS_
|
Map<String,String> |
|
quarkus.stork."service-name".service-registrar.type
Configures service registrar type, e.g. "consul". A ServiceRegistrarProvider for the type has to be available
Environment variable: QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR_TYPE
|
string |
required |
quarkus.stork."service-name".service-registrar."parameters"
Service Registrar parameters. Check the documentation of the selected registrar type for available parameters
Environment variable: QUARKUS_STORK__SERVICE_NAME__SERVICE_REGISTRAR__PARAMETERS_
|
Map<String,String> |
|
Spring - DI |
Type |
Default |
quarkus.spring-di.enabled
Whether Spring DI is enabled **during the build**.
Turning this setting off will result in Quarkus completely ignoring beans annotated with Spring annotations
Environment variable: QUARKUS_SPRING_DI_ENABLED
|
boolean |
true
|
Spring Boot - Properties |
Type |
Default |
quarkus.spring-boot-properties.configuration-properties-naming-strategy
The naming strategy used for org.springframework.boot.context.properties.ConfigurationProperties .
Environment variable: QUARKUS_SPRING_BOOT_PROPERTIES_CONFIGURATION_PROPERTIES_NAMING_STRATEGY
|
verbatim , kebab-case , snake-case
|
kebab-case
|
Swagger UI |
Type |
Default |
The path where Swagger UI is available.
The value / is not allowed as it blocks the application from serving anything else. By default, this value will be resolved as a path relative to ${quarkus.http.non-application-root-path} .
Environment variable: QUARKUS_SWAGGER_UI_PATH
|
string |
swagger-ui
|
quarkus.swagger-ui.always-include
If this should be included every time. By default, this is only included when the application is running in dev mode.
Environment variable: QUARKUS_SWAGGER_UI_ALWAYS_INCLUDE
|
boolean |
false
|
quarkus.swagger-ui.urls."name"
The urls that will be included as options. By default, the OpenAPI path will be used. Here you can override that and supply multiple urls that will appear in the TopBar plugin.
Environment variable: QUARKUS_SWAGGER_UI_URLS__NAME_
|
Map<String,String> |
|
quarkus.swagger-ui.urls-primary-name
If urls option is used, this will be the name of the default selection.
Environment variable: QUARKUS_SWAGGER_UI_URLS_PRIMARY_NAME
|
string |
|
The html title for the page.
Environment variable: QUARKUS_SWAGGER_UI_TITLE
|
string |
|
Swagger UI theme to be used.
Environment variable: QUARKUS_SWAGGER_UI_THEME
|
original , feeling-blue , flattop , material , monokai , muted , newspaper , outline
|
|
quarkus.swagger-ui.footer
A footer for the html page. Nothing by default.
Environment variable: QUARKUS_SWAGGER_UI_FOOTER
|
string |
|
quarkus.swagger-ui.deep-linking
If set to true, enables deep linking for tags and operations.
Environment variable: QUARKUS_SWAGGER_UI_DEEP_LINKING
|
boolean |
|
quarkus.swagger-ui.display-operation-id
Controls the display of operationId in operations list. The default is false.
Environment variable: QUARKUS_SWAGGER_UI_DISPLAY_OPERATION_ID
|
boolean |
|
quarkus.swagger-ui.default-models-expand-depth
The default expansion depth for models (set to -1 completely hide the models).
Environment variable: QUARKUS_SWAGGER_UI_DEFAULT_MODELS_EXPAND_DEPTH
|
int |
|
quarkus.swagger-ui.default-model-expand-depth
The default expansion depth for the model on the model-example section.
Environment variable: QUARKUS_SWAGGER_UI_DEFAULT_MODEL_EXPAND_DEPTH
|
int |
|
quarkus.swagger-ui.default-model-rendering
Controls how the model is shown when the API is first rendered.
Environment variable: QUARKUS_SWAGGER_UI_DEFAULT_MODEL_RENDERING
|
string |
|
quarkus.swagger-ui.display-request-duration
Controls the display of the request duration (in milliseconds) for "Try it out" requests.
Environment variable: QUARKUS_SWAGGER_UI_DISPLAY_REQUEST_DURATION
|
boolean |
|
quarkus.swagger-ui.doc-expansion
Controls the default expansion setting for the operations and tags.
Environment variable: QUARKUS_SWAGGER_UI_DOC_EXPANSION
|
|
|
quarkus.swagger-ui.filter
If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case-sensitive matching the filter expression anywhere inside the tag.
Environment variable: QUARKUS_SWAGGER_UI_FILTER
|
string |
|
quarkus.swagger-ui.max-displayed-tags
If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations.
Environment variable: QUARKUS_SWAGGER_UI_MAX_DISPLAYED_TAGS
|
int |
|
quarkus.swagger-ui.operations-sorter
Apply a sort to the operation list of each API. It can be 'alpha' (sort by paths alphanumerically), 'method' (sort by HTTP method) or a function (see Array.prototype.sort() to know how sort function works). Default is the order returned by the server unchanged.
Environment variable: QUARKUS_SWAGGER_UI_OPERATIONS_SORTER
|
string |
|
quarkus.swagger-ui.show-extensions
Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema.
Environment variable: QUARKUS_SWAGGER_UI_SHOW_EXTENSIONS
|
boolean |
|
quarkus.swagger-ui.show-common-extensions
Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters.
Environment variable: QUARKUS_SWAGGER_UI_SHOW_COMMON_EXTENSIONS
|
boolean |
|
quarkus.swagger-ui.tags-sorter
Apply a sort to the tag list of each API. It can be 'alpha' (sort by paths alphanumerically) or a function (see Array.prototype.sort() to learn how to write a sort function). Two tag name strings are passed to the sorter for each pass. Default is the order determined by Swagger UI.
Environment variable: QUARKUS_SWAGGER_UI_TAGS_SORTER
|
string |
|
quarkus.swagger-ui.on-complete
Provides a mechanism to be notified when Swagger UI has finished rendering a newly provided definition.
Environment variable: QUARKUS_SWAGGER_UI_ON_COMPLETE
|
string |
|
quarkus.swagger-ui.syntax-highlight
Set to false to deactivate syntax highlighting of payloads and cURL command. Can be otherwise an object with the activate and theme properties.
Environment variable: QUARKUS_SWAGGER_UI_SYNTAX_HIGHLIGHT
|
string |
|
quarkus.swagger-ui.oauth2-redirect-url
Environment variable: QUARKUS_SWAGGER_UI_OAUTH2_REDIRECT_URL
|
string |
|
quarkus.swagger-ui.request-interceptor
MUST be a function. Function to intercept remote definition, "Try it out", and OAuth 2.0 requests. Accepts one argument requestInterceptor(request) and must return the modified request, or a Promise that resolves to the modified request.
Environment variable: QUARKUS_SWAGGER_UI_REQUEST_INTERCEPTOR
|
string |
|
quarkus.swagger-ui.request-curl-options
If set, MUST be an array of command line options available to the curl command. This can be set on the mutated request in the requestInterceptor function.
Environment variable: QUARKUS_SWAGGER_UI_REQUEST_CURL_OPTIONS
|
list of string |
|
quarkus.swagger-ui.response-interceptor
MUST be a function. Function to intercept remote definition, "Try it out", and OAuth 2.0 responses. Accepts one argument responseInterceptor(response) and must return the modified response, or a Promise that resolves to the modified response.
Environment variable: QUARKUS_SWAGGER_UI_RESPONSE_INTERCEPTOR
|
string |
|
quarkus.swagger-ui.show-mutated-request
If set to true, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used.
Environment variable: QUARKUS_SWAGGER_UI_SHOW_MUTATED_REQUEST
|
boolean |
|
quarkus.swagger-ui.supported-submit-methods
List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display.
Environment variable: QUARKUS_SWAGGER_UI_SUPPORTED_SUBMIT_METHODS
|
list of get , put , post , delete , options , head , patch , trace
|
|
quarkus.swagger-ui.validator-url
By default, Swagger UI attempts to validate specs against swagger.io’s online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators (Validator Badge). Setting it to either none, 127.0.0.1 or localhost will disable validation.
Environment variable: QUARKUS_SWAGGER_UI_VALIDATOR_URL
|
string |
|
quarkus.swagger-ui.with-credentials
If set to true, enables passing credentials, as defined in the Fetch standard, in CORS requests that are sent by the browser.
Environment variable: QUARKUS_SWAGGER_UI_WITH_CREDENTIALS
|
boolean |
|
quarkus.swagger-ui.model-property-macro
Function to set default values to each property in model. Accepts one argument modelPropertyMacro(property), property is immutable
Environment variable: QUARKUS_SWAGGER_UI_MODEL_PROPERTY_MACRO
|
string |
|
quarkus.swagger-ui.parameter-macro
Function to set default value to parameters. Accepts two arguments parameterMacro(operation, parameter). Operation and parameter are objects passed for context, both remain immutable
Environment variable: QUARKUS_SWAGGER_UI_PARAMETER_MACRO
|
string |
|
quarkus.swagger-ui.persist-authorization
If set to true, it persists authorization data and it would not be lost on browser close/refresh
Environment variable: QUARKUS_SWAGGER_UI_PERSIST_AUTHORIZATION
|
boolean |
|
quarkus.swagger-ui.layout
The name of a component available via the plugin system to use as the top-level layout for Swagger UI.
Environment variable: QUARKUS_SWAGGER_UI_LAYOUT
|
string |
|
quarkus.swagger-ui.plugins
A list of plugin functions to use in Swagger UI.
Environment variable: QUARKUS_SWAGGER_UI_PLUGINS
|
list of string |
|
quarkus.swagger-ui.presets
A list of presets to use in Swagger UI.
Environment variable: QUARKUS_SWAGGER_UI_PRESETS
|
list of string |
|
quarkus.swagger-ui.oauth-client-id
OAuth default clientId - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_CLIENT_ID
|
string |
|
quarkus.swagger-ui.oauth-client-secret
OAuth default clientSecret - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_CLIENT_SECRET
|
string |
|
quarkus.swagger-ui.oauth-realm
OAuth1 Realm query parameter added to authorizationUrl and tokenUrl - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_REALM
|
string |
|
quarkus.swagger-ui.oauth-app-name
OAuth application name, displayed in authorization popup - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_APP_NAME
|
string |
|
quarkus.swagger-ui.oauth-scope-separator
OAuth scope separator for passing scopes - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_SCOPE_SEPARATOR
|
string |
|
quarkus.swagger-ui.oauth-scopes
OAuth Scopes, separated using the oauthScopeSeparator - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_SCOPES
|
string |
|
quarkus.swagger-ui.oauth-additional-query-string-params
OAuth additional query parameters added to authorizationUrl and tokenUrl - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_ADDITIONAL_QUERY_STRING_PARAMS
|
string |
|
quarkus.swagger-ui.oauth-use-basic-authentication-with-access-code-grant
OAuth only activated for the accessCode flow. During the authorization_code request to the tokenUrl, pass the Client Password using the HTTP Basic Authentication scheme - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_USE_BASIC_AUTHENTICATION_WITH_ACCESS_CODE_GRANT
|
boolean |
|
quarkus.swagger-ui.oauth-use-pkce-with-authorization-code-grant
OAuth only applies to authorization code flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients - Used in the initOAuth method.
Environment variable: QUARKUS_SWAGGER_UI_OAUTH_USE_PKCE_WITH_AUTHORIZATION_CODE_GRANT
|
boolean |
|
quarkus.swagger-ui.preauthorize-basic-auth-definition-key
Pre-authorize Basic Auth, programmatically set DefinitionKey for a Basic authorization scheme - Used in the preauthorizeBasic method.
Environment variable: QUARKUS_SWAGGER_UI_PREAUTHORIZE_BASIC_AUTH_DEFINITION_KEY
|
string |
|
quarkus.swagger-ui.preauthorize-basic-username
Pre-authorize Basic Auth, programmatically set Username for a Basic authorization scheme - Used in the preauthorizeBasic method.
Environment variable: QUARKUS_SWAGGER_UI_PREAUTHORIZE_BASIC_USERNAME
|
string |
|
quarkus.swagger-ui.preauthorize-basic-password
Pre-authorize Basic Auth, programmatically set Password for a Basic authorization scheme - Used in the preauthorizeBasic method.
Environment variable: QUARKUS_SWAGGER_UI_PREAUTHORIZE_BASIC_PASSWORD
|
string |
|
quarkus.swagger-ui.preauthorize-api-key-auth-definition-key
Pre-authorize ApiKey Auth, programmatically set DefinitionKey for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method.
Environment variable: QUARKUS_SWAGGER_UI_PREAUTHORIZE_API_KEY_AUTH_DEFINITION_KEY
|
string |
|
quarkus.swagger-ui.preauthorize-api-key-api-key-value
Pre-authorize ApiKey Auth, programmatically set ApiKeyValue for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method.
Environment variable: QUARKUS_SWAGGER_UI_PREAUTHORIZE_API_KEY_API_KEY_VALUE
|
string |
|
quarkus.swagger-ui.query-config-enabled
If set to true, this allows the user to modify and test different query parameters in the API request
Environment variable: QUARKUS_SWAGGER_UI_QUERY_CONFIG_ENABLED
|
boolean |
false
|
quarkus.swagger-ui.try-it-out-enabled
If try it out should be enabled by default
Environment variable: QUARKUS_SWAGGER_UI_TRY_IT_OUT_ENABLED
|
boolean |
false
|
quarkus.swagger-ui.enable
If Swagger UI is included, it should be enabled/disabled. By default, Swagger UI is enabled if it is included (see always-include ).
Environment variable: QUARKUS_SWAGGER_UI_ENABLE
|
boolean |
true
|
TLS Registry |
Type |
Default |
quarkus.tls.lets-encrypt.enabled
Set to true to enable let’s encrypt support.
Environment variable: QUARKUS_TLS_LETS_ENCRYPT_ENABLED
|
boolean |
false
|
quarkus.tls.key-store.pem.order
The order of the key/cert files, based on the names in the keyCerts map.
By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.
Environment variable: QUARKUS_TLS_KEY_STORE_PEM_ORDER
|
list of string |
|
quarkus.tls.key-store.p12.path
Path to the key store file (P12 / PFX format).
Environment variable: QUARKUS_TLS_KEY_STORE_P12_PATH
|
path |
required |
quarkus.tls.key-store.p12.password
Password of the key store. When not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_KEY_STORE_P12_PASSWORD
|
string |
|
quarkus.tls.key-store.p12.alias
Alias of the private key and certificate in the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_P12_ALIAS
|
string |
|
quarkus.tls.key-store.p12.alias-password
Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_KEY_STORE_P12_ALIAS_PASSWORD
|
string |
|
quarkus.tls.key-store.p12.provider
Provider of the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_P12_PROVIDER
|
string |
|
quarkus.tls.key-store.jks.path
Path to the keystore file (JKS format).
Environment variable: QUARKUS_TLS_KEY_STORE_JKS_PATH
|
path |
required |
quarkus.tls.key-store.jks.password
Password of the key store. When not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_KEY_STORE_JKS_PASSWORD
|
string |
|
quarkus.tls.key-store.jks.alias
Alias of the private key and certificate in the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_JKS_ALIAS
|
string |
|
quarkus.tls.key-store.jks.alias-password
Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_KEY_STORE_JKS_ALIAS_PASSWORD
|
string |
|
quarkus.tls.key-store.jks.provider
Provider of the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_JKS_PROVIDER
|
string |
|
quarkus.tls.key-store.sni
Enables Server Name Indication (SNI).
Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.
With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.
When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the password and alias-password properties. Do not set the alias property.
Environment variable: QUARKUS_TLS_KEY_STORE_SNI
|
boolean |
false
|
quarkus.tls.key-store.credentials-provider.name
The name of the "credential" bucket (map key → passwords) to retrieve from the io.quarkus.credentials.CredentialsProvider . If not set, the credential provider will not be used.
A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.
Environment variable: QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.tls.key-store.credentials-provider.bean-name
The name of the bean providing the credential provider.
The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the @Named annotation set to the configured name to be selected.
If not set, the default credential provider is used.
Environment variable: QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME
|
string |
|
quarkus.tls.key-store.credentials-provider.password-key
The key used to retrieve the key store password.
If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY
|
string |
password
|
quarkus.tls.key-store.credentials-provider.alias-password-key
The key used to retrieve the key store alias password.
If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias private key from the key store.
Environment variable: QUARKUS_TLS_KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY
|
string |
alias-password
|
quarkus.tls.trust-store.pem.certs
List of the trusted cert paths (Pem format).
Environment variable: QUARKUS_TLS_TRUST_STORE_PEM_CERTS
|
list of path |
|
quarkus.tls.trust-store.p12.path
Path to the trust store file (P12 / PFX format).
Environment variable: QUARKUS_TLS_TRUST_STORE_P12_PATH
|
path |
required |
quarkus.tls.trust-store.p12.password
Password of the trust store. If not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_TRUST_STORE_P12_PASSWORD
|
string |
|
quarkus.tls.trust-store.p12.alias
Alias of the trust store.
Environment variable: QUARKUS_TLS_TRUST_STORE_P12_ALIAS
|
string |
|
quarkus.tls.trust-store.p12.provider
Provider of the trust store.
Environment variable: QUARKUS_TLS_TRUST_STORE_P12_PROVIDER
|
string |
|
quarkus.tls.trust-store.jks.path
Path to the trust store file (JKS format).
Environment variable: QUARKUS_TLS_TRUST_STORE_JKS_PATH
|
path |
required |
quarkus.tls.trust-store.jks.password
Password of the trust store. If not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS_TRUST_STORE_JKS_PASSWORD
|
string |
|
quarkus.tls.trust-store.jks.alias
Alias of the key in the trust store.
Environment variable: QUARKUS_TLS_TRUST_STORE_JKS_ALIAS
|
string |
|
quarkus.tls.trust-store.jks.provider
Provider of the trust store.
Environment variable: QUARKUS_TLS_TRUST_STORE_JKS_PROVIDER
|
string |
|
quarkus.tls.trust-store.credentials-provider.name
The name of the "credential" bucket (map key → passwords) to retrieve from the io.quarkus.credentials.CredentialsProvider . If not set, the credential provider will not be used.
A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.
Environment variable: QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.tls.trust-store.credentials-provider.bean-name
The name of the bean providing the credential provider.
The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the @Named annotation set to the configured name to be selected.
If not set, the default credential provider is used.
Environment variable: QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME
|
string |
|
quarkus.tls.trust-store.credentials-provider.password-key
The key used to retrieve the trust store password.
If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.
Environment variable: QUARKUS_TLS_TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY
|
string |
password
|
quarkus.tls.cipher-suites
Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers.
When suites are set, it takes precedence over the default suite defined by the SSLEngineOptions in use.
Environment variable: QUARKUS_TLS_CIPHER_SUITES
|
list of string |
|
Sets the ordered list of enabled TLS protocols.
If not set, it defaults to "TLSv1.3, TLSv1.2" . The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 . To only enable TLSv1.3 , set the value to to "TLSv1.3" .
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
Also, setting this replaces the default list of protocols.
Environment variable: QUARKUS_TLS_PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
quarkus.tls.handshake-timeout
The timeout for the TLS handshake phase.
If not set, it defaults to 10 seconds.
Environment variable: QUARKUS_TLS_HANDSHAKE_TIMEOUT
|
Duration |
10S
|
Enables the Application-Layer Protocol Negotiation (ALPN).
Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection.
Environment variable: QUARKUS_TLS_ALPN
|
boolean |
true
|
quarkus.tls.certificate-revocation-list
Sets the list of revoked certificates (paths to files).
A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore.
Two formats are allowed: DER and PKCS#7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS#7 format, you must pass PKCS#7 SignedData object, with the only significant field being crls .
Environment variable: QUARKUS_TLS_CERTIFICATE_REVOCATION_LIST
|
list of path |
|
If set to true , the server trusts all certificates.
This is useful for testing, but should not be used in production.
Environment variable: QUARKUS_TLS_TRUST_ALL
|
boolean |
false
|
quarkus.tls.hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS (default), LDAPS or an NONE .
If set to NONE , it does not verify the hostname.
If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS".
Environment variable: QUARKUS_TLS_HOSTNAME_VERIFICATION_ALGORITHM
|
string |
|
quarkus.tls.reload-period
When configured, the server will reload the certificates (from the file system for example) and fires a CertificateUpdatedEvent if the reload is successful
This property configures the period to reload the certificates. IF not set, the certificates won’t be reloaded automatically. However, the application can still trigger the reload manually using the io.quarkus.tls.TlsConfiguration#reload() method, and then fire the CertificateUpdatedEvent manually.
The fired event is used to notify the application that the certificates have been updated, and thus proceed with the actual switch of certificates.
Environment variable: QUARKUS_TLS_RELOAD_PERIOD
|
Duration |
|
quarkus.tls.key-store.pem."key-certs".key
The path to the key file (in PEM format).
Environment variable: QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__KEY
|
path |
required |
quarkus.tls.key-store.pem."key-certs".cert
The path to the certificate file (in PEM format).
Environment variable: QUARKUS_TLS_KEY_STORE_PEM__KEY_CERTS__CERT
|
path |
required |
quarkus.tls."tls-bucket-name".key-store.pem."key-certs".key
The path to the key file (in PEM format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__KEY
|
path |
required |
quarkus.tls."tls-bucket-name".key-store.pem."key-certs".cert
The path to the certificate file (in PEM format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM__KEY_CERTS__CERT
|
path |
required |
quarkus.tls."tls-bucket-name".key-store.pem.order
The order of the key/cert files, based on the names in the keyCerts map.
By default, Quarkus sorts the key using a lexicographical order. This property allows you to specify the order of the key/cert files.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_PEM_ORDER
|
list of string |
|
quarkus.tls."tls-bucket-name".key-store.p12.path
Path to the key store file (P12 / PFX format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PATH
|
path |
required |
quarkus.tls."tls-bucket-name".key-store.p12.password
Password of the key store. When not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".key-store.p12.alias
Alias of the private key and certificate in the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS
|
string |
|
quarkus.tls."tls-bucket-name".key-store.p12.alias-password
Password of the alias in the key store. If not set, the password will be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_ALIAS_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".key-store.p12.provider
Provider of the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_P12_PROVIDER
|
string |
|
quarkus.tls."tls-bucket-name".key-store.jks.path
Path to the keystore file (JKS format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PATH
|
path |
required |
quarkus.tls."tls-bucket-name".key-store.jks.password
Password of the key store. When not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".key-store.jks.alias
Alias of the private key and certificate in the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS
|
string |
|
quarkus.tls."tls-bucket-name".key-store.jks.alias-password
Password of the alias in the key store. When not set, the password may be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_ALIAS_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".key-store.jks.provider
Provider of the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_JKS_PROVIDER
|
string |
|
quarkus.tls."tls-bucket-name".key-store.sni
Enables Server Name Indication (SNI).
Server Name Indication (SNI) is a TLS extension that allows a client to specify the hostname it is attempting to connect to during the TLS handshake. This enables a server to present different SSL certificates for multiple domains on a single IP address, facilitating secure communication for virtual hosting scenarios.
With this setting enabled, the client indicate the server name during the TLS handshake, allowing the server to select the right certificate.
When configuring the keystore with PEM files, multiple CRT/Key must be given. When configuring the keystore with a JKS or a P12 file, it selects one alias based on the SNI hostname. In this case, all the keystore password and alias password must be the same (configured with the password and alias-password properties. Do not set the alias property.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_SNI
|
boolean |
false
|
quarkus.tls."tls-bucket-name".key-store.credentials-provider.name
The name of the "credential" bucket (map key → passwords) to retrieve from the io.quarkus.credentials.CredentialsProvider . If not set, the credential provider will not be used.
A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.tls."tls-bucket-name".key-store.credentials-provider.bean-name
The name of the bean providing the credential provider.
The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the @Named annotation set to the configured name to be selected.
If not set, the default credential provider is used.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_BEAN_NAME
|
string |
|
quarkus.tls."tls-bucket-name".key-store.credentials-provider.password-key
The key used to retrieve the key store password.
If the selected credential provider does not support the key, the password is not retrieved. Otherwise, the retrieved value is used to open the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY
|
string |
password
|
quarkus.tls."tls-bucket-name".key-store.credentials-provider.alias-password-key
The key used to retrieve the key store alias password.
If the selected credential provider does not contain the key, the alias password is not retrieved. Otherwise, the retrieved value is used to access the alias private key from the key store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__KEY_STORE_CREDENTIALS_PROVIDER_ALIAS_PASSWORD_KEY
|
string |
alias-password
|
quarkus.tls."tls-bucket-name".trust-store.pem.certs
List of the trusted cert paths (Pem format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_PEM_CERTS
|
list of path |
|
quarkus.tls."tls-bucket-name".trust-store.p12.path
Path to the trust store file (P12 / PFX format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PATH
|
path |
required |
quarkus.tls."tls-bucket-name".trust-store.p12.password
Password of the trust store. If not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.p12.alias
Alias of the trust store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_ALIAS
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.p12.provider
Provider of the trust store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_P12_PROVIDER
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.jks.path
Path to the trust store file (JKS format).
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PATH
|
path |
required |
quarkus.tls."tls-bucket-name".trust-store.jks.password
Password of the trust store. If not set, the password must be retrieved from the credential provider.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PASSWORD
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.jks.alias
Alias of the key in the trust store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_ALIAS
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.jks.provider
Provider of the trust store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_JKS_PROVIDER
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.credentials-provider.name
The name of the "credential" bucket (map key → passwords) to retrieve from the io.quarkus.credentials.CredentialsProvider . If not set, the credential provider will not be used.
A credential provider offers a way to retrieve the key store password as well as alias password. Note that the credential provider is only used if the passwords are not set in the configuration.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_NAME
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.credentials-provider.bean-name
The name of the bean providing the credential provider.
The name is used to select the credential provider to use. The credential provider must be exposed as a CDI bean and with the @Named annotation set to the configured name to be selected.
If not set, the default credential provider is used.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_BEAN_NAME
|
string |
|
quarkus.tls."tls-bucket-name".trust-store.credentials-provider.password-key
The key used to retrieve the trust store password.
If the selected credential provider does not contain the configured key, the password is not retrieved. Otherwise, the retrieved value is used to open the trust store.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_STORE_CREDENTIALS_PROVIDER_PASSWORD_KEY
|
string |
password
|
quarkus.tls."tls-bucket-name".cipher-suites
Sets the ordered list of enabled cipher suites. If none is given, a reasonable default is selected from the built-in ciphers.
When suites are set, it takes precedence over the default suite defined by the SSLEngineOptions in use.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__CIPHER_SUITES
|
list of string |
|
quarkus.tls."tls-bucket-name".protocols
Sets the ordered list of enabled TLS protocols.
If not set, it defaults to "TLSv1.3, TLSv1.2" . The following list of protocols are supported: TLSv1, TLSv1.1, TLSv1.2, TLSv1.3 . To only enable TLSv1.3 , set the value to to "TLSv1.3" .
Note that setting an empty list, and enabling TLS is invalid. You must at least have one protocol.
Also, setting this replaces the default list of protocols.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__PROTOCOLS
|
list of string |
TLSv1.3,TLSv1.2
|
quarkus.tls."tls-bucket-name".handshake-timeout
The timeout for the TLS handshake phase.
If not set, it defaults to 10 seconds.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__HANDSHAKE_TIMEOUT
|
Duration |
10S
|
quarkus.tls."tls-bucket-name".alpn
Enables the Application-Layer Protocol Negotiation (ALPN).
Application-Layer Protocol Negotiation is a TLS extension that allows the client and server during the TLS handshake to negotiate which protocol they will use for communication. ALPN enables more efficient communication by allowing the client to indicate its preferred application protocol to the server before the TLS connection is established. This helps in scenarios such as HTTP/2 where multiple protocols may be available, allowing for faster protocol selection.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__ALPN
|
boolean |
true
|
quarkus.tls."tls-bucket-name".certificate-revocation-list
Sets the list of revoked certificates (paths to files).
A Certificate Revocation List (CRL) is a list of digital certificates that have been revoked by the issuing Certificate Authority (CA) before their scheduled expiration date. When a certificate is compromised, no longer needed, or deemed invalid for any reason, the CA adds it to the CRL to inform relying parties not to trust the certificate anymore.
Two formats are allowed: DER and PKCS#7 (also known as P7B). When using the DER format, you must pass DER-encoded CRLs. When using the PKCS#7 format, you must pass PKCS#7 SignedData object, with the only significant field being crls .
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__CERTIFICATE_REVOCATION_LIST
|
list of path |
|
quarkus.tls."tls-bucket-name".trust-all
If set to true , the server trusts all certificates.
This is useful for testing, but should not be used in production.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__TRUST_ALL
|
boolean |
false
|
quarkus.tls."tls-bucket-name".hostname-verification-algorithm
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS (default), LDAPS or an NONE .
If set to NONE , it does not verify the hostname.
If not set, the configured extension decides the default algorithm to use. For example, for HTTP, it will be "HTTPS". For TCP, it can depend on the protocol. Nevertheless, it is recommended to set it to "HTTPS" or "LDAPS".
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__HOSTNAME_VERIFICATION_ALGORITHM
|
string |
|
quarkus.tls."tls-bucket-name".reload-period
When configured, the server will reload the certificates (from the file system for example) and fires a CertificateUpdatedEvent if the reload is successful
This property configures the period to reload the certificates. IF not set, the certificates won’t be reloaded automatically. However, the application can still trigger the reload manually using the io.quarkus.tls.TlsConfiguration#reload() method, and then fire the CertificateUpdatedEvent manually.
The fired event is used to notify the application that the certificates have been updated, and thus proceed with the actual switch of certificates.
Environment variable: QUARKUS_TLS__TLS_BUCKET_NAME__RELOAD_PERIOD
|
Duration |
|
Undertow |
Type |
Default |
quarkus.servlet.context-path
The context path for Servlet content. This will determine the path used to resolve all Servlet-based resources, including JAX-RS resources - when using the Undertow extension in conjunction with RESTEasy.
This path is specified with a leading / , but is resolved relative to quarkus.http.root-path .
-
If quarkus.http.root-path=/ and quarkus.servlet.context-path=/bar , the servlet path will be /bar
-
If quarkus.http.root-path=/foo and quarkus.servlet.context-path=/bar , the servlet path will be /foo/bar
Environment variable: QUARKUS_SERVLET_CONTEXT_PATH
|
string |
|
quarkus.servlet.default-charset
The default charset to use for reading and writing requests
Environment variable: QUARKUS_SERVLET_DEFAULT_CHARSET
|
string |
UTF-8
|
quarkus.servlet.buffer-size
The buffer size to use for Servlet. If this is not specified the default will depend on the amount of available memory. If there is less than 64mb it will default to 512b heap buffer, less that 128mb 1k direct buffer and otherwise 16k direct buffers.
Environment variable: QUARKUS_SERVLET_BUFFER_SIZE
|
MemorySize |
|
quarkus.servlet.direct-buffers
If Servlet should use direct buffers, this gives maximum performance but can be problematic in memory constrained environments
Environment variable: QUARKUS_SERVLET_DIRECT_BUFFERS
|
boolean |
|
quarkus.servlet.max-parameters
The maximum number of HTTP request parameters permitted for Servlet requests. If a client sends more than this number of parameters in a request, the connection is closed.
Environment variable: QUARKUS_SERVLET_MAX_PARAMETERS
|
int |
1000
|
Vert.x |
Type |
Default |
Enables or disables the Vert.x cache.
Environment variable: QUARKUS_VERTX_CACHING
|
boolean |
true
|
quarkus.vertx.cache-directory
Configure the file cache directory. When not set, the cache is stored in the system temporary directory (read from the java.io.tmpdir system property). If the java.io.tmpdir is not set . is used.
Note that this property is ignored if the vertx.cacheDirBase system property is set.
Environment variable: QUARKUS_VERTX_CACHE_DIRECTORY
|
string |
|
quarkus.vertx.classpath-resolving
Enables or disabled the Vert.x classpath resource resolver.
Environment variable: QUARKUS_VERTX_CLASSPATH_RESOLVING
|
boolean |
true
|
quarkus.vertx.event-loops-pool-size
The number of event loops. By default, it matches the number of CPUs detected on the system.
Environment variable: QUARKUS_VERTX_EVENT_LOOPS_POOL_SIZE
|
int |
|
quarkus.vertx.max-event-loop-execute-time
The maximum amount of time the event loop can be blocked.
Environment variable: QUARKUS_VERTX_MAX_EVENT_LOOP_EXECUTE_TIME
|
Duration |
2S
|
quarkus.vertx.warning-exception-time
The amount of time before a warning is displayed if the event loop is blocked.
Environment variable: QUARKUS_VERTX_WARNING_EXCEPTION_TIME
|
Duration |
2S
|
quarkus.vertx.max-worker-execute-time
The maximum amount of time the worker thread can be blocked.
Environment variable: QUARKUS_VERTX_MAX_WORKER_EXECUTE_TIME
|
Duration |
60S
|
quarkus.vertx.internal-blocking-pool-size
The size of the internal thread pool (used for the file system).
Environment variable: QUARKUS_VERTX_INTERNAL_BLOCKING_POOL_SIZE
|
int |
20
|
The queue size. For most applications this should be unbounded
Environment variable: QUARKUS_VERTX_QUEUE_SIZE
|
int |
|
quarkus.vertx.growth-resistance
The executor growth resistance.
A resistance factor applied after the core pool is full; values applied here will cause that fraction of submissions to create new threads when no idle thread is available. A value of 0.0f implies that threads beyond the core size should be created as aggressively as threads within it; a value of 1.0f implies that threads beyond the core size should never be created.
Environment variable: QUARKUS_VERTX_GROWTH_RESISTANCE
|
float |
0
|
quarkus.vertx.keep-alive-time
The amount of time a thread will stay alive with no work.
Environment variable: QUARKUS_VERTX_KEEP_ALIVE_TIME
|
Duration |
30S
|
Prefill thread pool when creating a new Executor. When io.vertx.core.spi.ExecutorServiceFactory#createExecutor is called, initialise with the number of defined threads at startup
Environment variable: QUARKUS_VERTX_PREFILL
|
boolean |
false
|
quarkus.vertx.use-async-dns
Enables the async DNS resolver.
Environment variable: QUARKUS_VERTX_USE_ASYNC_DNS
|
boolean |
false
|
quarkus.vertx.eventbus.key-certificate-pem
PEM Key/cert config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.vertx.eventbus.key-certificate-pem.keys
Comma-separated list of the path to the key files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM_KEYS
|
list of string |
|
quarkus.vertx.eventbus.key-certificate-pem.certs
Comma-separated list of the path to the certificate files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.vertx.eventbus.key-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.vertx.eventbus.key-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.vertx.eventbus.key-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.vertx.eventbus.key-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.vertx.eventbus.key-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.vertx.eventbus.key-certificate-pfx.password
Environment variable: QUARKUS_VERTX_EVENTBUS_KEY_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.vertx.eventbus.trust-certificate-pem
PEM Trust config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PEM
|
boolean |
false
|
quarkus.vertx.eventbus.trust-certificate-pem.certs
Comma-separated list of the trust certificate files (Pem format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PEM_CERTS
|
list of string |
|
quarkus.vertx.eventbus.trust-certificate-jks
JKS config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS
|
boolean |
false
|
quarkus.vertx.eventbus.trust-certificate-jks.path
Path of the key file (JKS format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS_PATH
|
string |
|
quarkus.vertx.eventbus.trust-certificate-jks.password
Password of the key file.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_JKS_PASSWORD
|
string |
|
quarkus.vertx.eventbus.trust-certificate-pfx
PFX config is disabled by default.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX
|
boolean |
false
|
quarkus.vertx.eventbus.trust-certificate-pfx.path
Path to the key file (PFX format).
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX_PATH
|
string |
|
quarkus.vertx.eventbus.trust-certificate-pfx.password
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_CERTIFICATE_PFX_PASSWORD
|
string |
|
quarkus.vertx.eventbus.accept-backlog
Environment variable: QUARKUS_VERTX_EVENTBUS_ACCEPT_BACKLOG
|
int |
|
quarkus.vertx.eventbus.client-auth
The client authentication.
Environment variable: QUARKUS_VERTX_EVENTBUS_CLIENT_AUTH
|
string |
NONE
|
quarkus.vertx.eventbus.connect-timeout
Environment variable: QUARKUS_VERTX_EVENTBUS_CONNECT_TIMEOUT
|
Duration |
60S
|
quarkus.vertx.eventbus.idle-timeout
The idle timeout in milliseconds.
Environment variable: QUARKUS_VERTX_EVENTBUS_IDLE_TIMEOUT
|
Duration |
|
quarkus.vertx.eventbus.receive-buffer-size
Environment variable: QUARKUS_VERTX_EVENTBUS_RECEIVE_BUFFER_SIZE
|
int |
|
quarkus.vertx.eventbus.reconnect-attempts
The number of reconnection attempts.
Environment variable: QUARKUS_VERTX_EVENTBUS_RECONNECT_ATTEMPTS
|
int |
0
|
quarkus.vertx.eventbus.reconnect-interval
The reconnection interval in milliseconds.
Environment variable: QUARKUS_VERTX_EVENTBUS_RECONNECT_INTERVAL
|
Duration |
1S
|
quarkus.vertx.eventbus.reuse-address
Whether to reuse the address.
Environment variable: QUARKUS_VERTX_EVENTBUS_REUSE_ADDRESS
|
boolean |
true
|
quarkus.vertx.eventbus.reuse-port
Whether to reuse the port.
Environment variable: QUARKUS_VERTX_EVENTBUS_REUSE_PORT
|
boolean |
false
|
quarkus.vertx.eventbus.send-buffer-size
Environment variable: QUARKUS_VERTX_EVENTBUS_SEND_BUFFER_SIZE
|
int |
|
quarkus.vertx.eventbus.so-linger
Environment variable: QUARKUS_VERTX_EVENTBUS_SO_LINGER
|
int |
|
quarkus.vertx.eventbus.ssl
Environment variable: QUARKUS_VERTX_EVENTBUS_SSL
|
boolean |
false
|
quarkus.vertx.eventbus.tcp-keep-alive
Whether to keep the TCP connection opened (keep-alive).
Environment variable: QUARKUS_VERTX_EVENTBUS_TCP_KEEP_ALIVE
|
boolean |
false
|
quarkus.vertx.eventbus.tcp-no-delay
Configure the TCP no delay.
Environment variable: QUARKUS_VERTX_EVENTBUS_TCP_NO_DELAY
|
boolean |
true
|
quarkus.vertx.eventbus.traffic-class
Configure the traffic class.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRAFFIC_CLASS
|
int |
|
quarkus.vertx.eventbus.trust-all
Enables or disables the trust all parameter.
Environment variable: QUARKUS_VERTX_EVENTBUS_TRUST_ALL
|
boolean |
false
|
quarkus.vertx.cluster.host
Environment variable: QUARKUS_VERTX_CLUSTER_HOST
|
string |
localhost
|
quarkus.vertx.cluster.port
Environment variable: QUARKUS_VERTX_CLUSTER_PORT
|
int |
|
quarkus.vertx.cluster.public-host
Environment variable: QUARKUS_VERTX_CLUSTER_PUBLIC_HOST
|
string |
|
quarkus.vertx.cluster.public-port
Environment variable: QUARKUS_VERTX_CLUSTER_PUBLIC_PORT
|
int |
|
quarkus.vertx.cluster.clustered
Enables or disables the clustering.
Environment variable: QUARKUS_VERTX_CLUSTER_CLUSTERED
|
boolean |
false
|
quarkus.vertx.cluster.ping-interval
Environment variable: QUARKUS_VERTX_CLUSTER_PING_INTERVAL
|
Duration |
20S
|
quarkus.vertx.cluster.ping-reply-interval
Environment variable: QUARKUS_VERTX_CLUSTER_PING_REPLY_INTERVAL
|
Duration |
20S
|
quarkus.vertx.resolver.cache-max-time-to-live
The maximum amount of time in seconds that a successfully resolved address will be cached.
If not set explicitly, resolved addresses may be cached forever.
Environment variable: QUARKUS_VERTX_RESOLVER_CACHE_MAX_TIME_TO_LIVE
|
int |
2147483647
|
quarkus.vertx.resolver.cache-min-time-to-live
The minimum amount of time in seconds that a successfully resolved address will be cached.
Environment variable: QUARKUS_VERTX_RESOLVER_CACHE_MIN_TIME_TO_LIVE
|
int |
0
|
quarkus.vertx.resolver.cache-negative-time-to-live
The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached.
Environment variable: QUARKUS_VERTX_RESOLVER_CACHE_NEGATIVE_TIME_TO_LIVE
|
int |
0
|
quarkus.vertx.resolver.max-queries
The maximum number of queries to be sent during a resolution.
Environment variable: QUARKUS_VERTX_RESOLVER_MAX_QUERIES
|
int |
4
|
quarkus.vertx.resolver.query-timeout
The duration after which a DNS query is considered to be failed.
Environment variable: QUARKUS_VERTX_RESOLVER_QUERY_TIMEOUT
|
Duration |
5S
|
quarkus.vertx.resolver.hosts-path
Set the path of an alternate hosts configuration file to use instead of the one provided by the os.
The default value is null , so the operating system hosts config (e.g. /etc/hosts ) is used.
Environment variable: QUARKUS_VERTX_RESOLVER_HOSTS_PATH
|
string |
|
quarkus.vertx.resolver.host-refresh-period
Set the hosts configuration refresh period in millis, 0 (default) disables it.
The resolver caches the hosts configuration (configured using quarkus.vertx.resolver.hosts-path after it has read it. When the content of this file can change, setting a positive refresh period will load the configuration file again when necessary.
Environment variable: QUARKUS_VERTX_RESOLVER_HOST_REFRESH_PERIOD
|
int |
0
|
quarkus.vertx.resolver.servers
Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port, e.g 8.8.8.8 or {code 192.168.0.1:40000}. When the list is empty, the resolver will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved it will use Google’s public DNS servers "8.8.8.8" and "8.8.4.4" .
Environment variable: QUARKUS_VERTX_RESOLVER_SERVERS
|
list of string |
|
quarkus.vertx.resolver.opt-resource-enabled
Set to true to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.
Environment variable: QUARKUS_VERTX_RESOLVER_OPT_RESOURCE_ENABLED
|
boolean |
false
|
quarkus.vertx.resolver.rd-flag
Set the DNS queries Recursion Desired flag value.
Environment variable: QUARKUS_VERTX_RESOLVER_RD_FLAG
|
boolean |
true
|
quarkus.vertx.resolver.search-domains
Set the lists of DNS search domains.
When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.
Environment variable: QUARKUS_VERTX_RESOLVER_SEARCH_DOMAINS
|
list of string |
|
quarkus.vertx.resolver.ndots
Set the ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1 .
Environment variable: QUARKUS_VERTX_RESOLVER_NDOTS
|
int |
-1
|
quarkus.vertx.resolver.rotate-servers
Set to true to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.
Environment variable: QUARKUS_VERTX_RESOLVER_ROTATE_SERVERS
|
boolean |
|
quarkus.vertx.resolver.round-robin-inet-address
Set to true to enable round-robin inet address selection of the ip address to use.
Environment variable: QUARKUS_VERTX_RESOLVER_ROUND_ROBIN_INET_ADDRESS
|
boolean |
false
|
quarkus.vertx.prefer-native-transport
Enable or disable native transport
Environment variable: QUARKUS_VERTX_PREFER_NATIVE_TRANSPORT
|
boolean |
false
|
Virtual Threads Support |
Type |
Default |
quarkus.virtual-threads.name-prefix
Virtual thread name prefix. If left blank virtual threads will be unnamed.
Environment variable: QUARKUS_VIRTUAL_THREADS_NAME_PREFIX
|
string |
quarkus-virtual-thread-
|
quarkus.virtual-threads.shutdown-timeout
The shutdown timeout. If all pending work has not been completed by this time then any pending tasks will be interrupted, and the shutdown process will continue
Environment variable: QUARKUS_VIRTUAL_THREADS_SHUTDOWN_TIMEOUT
|
Duration |
1M
|
quarkus.virtual-threads.shutdown-check-interval
The frequency at which the status of the executor service should be checked during shutdown. Setting this key to an empty value disables the shutdown check interval.
Environment variable: QUARKUS_VIRTUAL_THREADS_SHUTDOWN_CHECK_INTERVAL
|
Duration |
5S
|
quarkus.virtual-threads.enabled
A flag to explicitly disabled virtual threads, even if the JVM support them. In this case, methods annotated with @RunOnVirtualThread are executed on the worker thread pool.
This flag is intended to be used when running with virtual threads become more expensive than plain worker threads, because of pinning, monopolization or thread-based object pool.
Environment variable: QUARKUS_VIRTUAL_THREADS_ENABLED
|
boolean |
true
|
Web Dependency Locator |
Type |
Default |
quarkus.web-dependency-locator.version-reroute
If the version reroute is enabled.
Environment variable: QUARKUS_WEB_DEPENDENCY_LOCATOR_VERSION_REROUTE
|
boolean |
true
|
quarkus.web-dependency-locator.import-mappings."module-specifier"
User defined import mappings
Environment variable: QUARKUS_WEB_DEPENDENCY_LOCATOR_IMPORT_MAPPINGS__MODULE_SPECIFIER_
|
Map<String,String> |
|
quarkus.web-dependency-locator.web-root
The directory in the resources which serves as root for the web assets
Environment variable: QUARKUS_WEB_DEPENDENCY_LOCATOR_WEB_ROOT
|
string |
web
|
quarkus.web-dependency-locator.app-root
The directory in the resources which serves as root for the app assets
Environment variable: QUARKUS_WEB_DEPENDENCY_LOCATOR_APP_ROOT
|
string |
app
|
WebSockets Client |
Type |
Default |
quarkus.websocket.max-frame-size
The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames.
Environment variable: QUARKUS_WEBSOCKET_MAX_FRAME_SIZE
|
int |
65536
|
quarkus.websocket.dispatch-to-worker
If the websocket methods should be run in a worker thread. This allows them to run blocking tasks, however it will not be as fast as running directly in the IO thread.
Environment variable: QUARKUS_WEBSOCKET_DISPATCH_TO_WORKER
|
boolean |
false
|
WebSockets Next |
Type |
Default |
quarkus.websockets-next.client.offer-per-message-compression
Compression Extensions for WebSocket are supported by default.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_OFFER_PER_MESSAGE_COMPRESSION
|
boolean |
false
|
quarkus.websockets-next.client.compression-level
The compression level must be a value between 0 and 9. The default value is io.vertx.core.http.HttpClientOptions#DEFAULT_WEBSOCKET_COMPRESSION_LEVEL .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_COMPRESSION_LEVEL
|
int |
|
quarkus.websockets-next.client.max-message-size
The maximum size of a message in bytes. The default values is io.vertx.core.http.HttpClientOptions#DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_MAX_MESSAGE_SIZE
|
int |
|
quarkus.websockets-next.client.auto-ping-interval
The interval after which, when set, the client sends a ping message to a connected server automatically.
Ping messages are not sent automatically by default.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_AUTO_PING_INTERVAL
|
Duration |
|
quarkus.websockets-next.client.unhandled-failure-strategy
The strategy used when an error occurs but no error handler can handle the failure.
By default, the connection is closed when an unhandled failure occurs.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_UNHANDLED_FAILURE_STRATEGY
|
|
close
|
quarkus.websockets-next.client.tls-configuration-name
The name of the TLS configuration to use.
If a name is configured, it uses the configuration from quarkus.tls.<name>.* If a name is configured, but no TLS configuration is found with that name then an error will be thrown.
The default TLS configuration is not used by default.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_TLS_CONFIGURATION_NAME
|
string |
|
quarkus.websockets-next.client.traffic-logging.enabled
If set to true then binary/text messages received/sent are logged if the DEBUG level is enabled for the logger io.quarkus.websockets.next.traffic .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_ENABLED
|
boolean |
false
|
quarkus.websockets-next.client.traffic-logging.text-payload-limit
The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_CLIENT_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT
|
int |
100
|
quarkus.websockets-next.server.supported-subprotocols
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS
|
list of string |
|
quarkus.websockets-next.server.per-message-compression-supported
Compression Extensions for WebSocket are supported by default.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED
|
boolean |
true
|
quarkus.websockets-next.server.compression-level
The compression level must be a value between 0 and 9. The default value is io.vertx.core.http.HttpServerOptions#DEFAULT_WEBSOCKET_COMPRESSION_LEVEL .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL
|
int |
|
quarkus.websockets-next.server.max-message-size
The maximum size of a message in bytes. The default values is io.vertx.core.http.HttpServerOptions#DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE
|
int |
|
quarkus.websockets-next.server.auto-ping-interval
The interval after which, when set, the server sends a ping message to a connected client automatically.
Ping messages are not sent automatically by default.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL
|
Duration |
|
quarkus.websockets-next.server.unhandled-failure-strategy
The strategy used when an error occurs but no error handler can handle the failure.
By default, the connection is closed when an unhandled failure occurs.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_UNHANDLED_FAILURE_STRATEGY
|
|
close
|
quarkus.websockets-next.server.security.auth-failure-redirect-url
Quarkus redirects HTTP handshake request to this URL if an HTTP upgrade is rejected due to the authorization failure. This configuration property takes effect when you secure endpoint with a standard security annotation. For example, the HTTP upgrade is secured if an endpoint class is annotated with the @RolesAllowed annotation.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_SECURITY_AUTH_FAILURE_REDIRECT_URL
|
string |
|
quarkus.websockets-next.server.dev-mode.connection-messages-limit
The limit of messages kept for a Dev UI connection. If less than zero then no messages are stored and sent to the Dev UI view.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_DEV_MODE_CONNECTION_MESSAGES_LIMIT
|
long |
1000
|
quarkus.websockets-next.server.traffic-logging.enabled
If set to true then binary/text messages received/sent are logged if the DEBUG level is enabled for the logger io.quarkus.websockets.next.traffic .
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_ENABLED
|
boolean |
false
|
quarkus.websockets-next.server.traffic-logging.text-payload-limit
The number of characters of a text message which will be logged if traffic logging is enabled. The payload of a binary message is never logged.
Environment variable: QUARKUS_WEBSOCKETS_NEXT_SERVER_TRAFFIC_LOGGING_TEXT_PAYLOAD_LIMIT
|
int |
100
|