Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. |
list of class name |
|||||||||||||||||||||||||||||||
The handler name. Handler names are specified on handler classes using the |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Port to access mock event server in dev mode |
int |
|
||||||||||||||||||||||||||||||
Port to access mock event server in dev mode |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enable security mechanisms to process lambda and AWS based security (i.e. Cognito, IAM) from the http event sent from API Gateway |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If we create a JDBC datasource for this datasource. |
boolean |
|
||||||||||||||||||||||||||||||
The datasource driver class name |
string |
|||||||||||||||||||||||||||||||
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing |
|
|
||||||||||||||||||||||||||||||
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active. |
boolean |
|||||||||||||||||||||||||||||||
The datasource URL |
string |
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
The datasource pool minimum size |
int |
|
||||||||||||||||||||||||||||||
The datasource pool maximum size |
int |
|
||||||||||||||||||||||||||||||
The interval at which we validate idle connections in the background.
Set to |
|
|||||||||||||||||||||||||||||||
Perform foreground validation on connections that have been idle for longer than the specified interval. |
||||||||||||||||||||||||||||||||
The timeout before cancelling the acquisition of a new connection |
|
|||||||||||||||||||||||||||||||
The interval at which we check for connection leaks. |
||||||||||||||||||||||||||||||||
The interval at which we try to remove idle connections. |
|
|||||||||||||||||||||||||||||||
The max lifetime of a connection. |
||||||||||||||||||||||||||||||||
The transaction isolation level. |
|
|||||||||||||||||||||||||||||||
Collect and display extra troubleshooting info on leaked connections. |
boolean |
|
||||||||||||||||||||||||||||||
Allows connections to be flushed upon return to the pool. It’s not enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Query executed when first using a connection. |
string |
|||||||||||||||||||||||||||||||
Query executed to validate a connection. |
string |
|||||||||||||||||||||||||||||||
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If we create a JDBC datasource for this datasource. |
boolean |
|
||||||||||||||||||||||||||||||
The datasource driver class name |
string |
|||||||||||||||||||||||||||||||
Whether we want to use regular JDBC transactions, XA, or disable all transactional capabilities.
When enabling XA you will need a driver implementing |
|
|
||||||||||||||||||||||||||||||
Enable datasource metrics collection. If unspecified, collecting metrics will be enabled by default if a metrics extension is active. |
boolean |
|||||||||||||||||||||||||||||||
The datasource URL |
string |
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
The datasource pool minimum size |
int |
|
||||||||||||||||||||||||||||||
The datasource pool maximum size |
int |
|
||||||||||||||||||||||||||||||
The interval at which we validate idle connections in the background.
Set to |
|
|||||||||||||||||||||||||||||||
Perform foreground validation on connections that have been idle for longer than the specified interval. |
||||||||||||||||||||||||||||||||
The timeout before cancelling the acquisition of a new connection |
|
|||||||||||||||||||||||||||||||
The interval at which we check for connection leaks. |
||||||||||||||||||||||||||||||||
The interval at which we try to remove idle connections. |
|
|||||||||||||||||||||||||||||||
The max lifetime of a connection. |
||||||||||||||||||||||||||||||||
The transaction isolation level. |
|
|||||||||||||||||||||||||||||||
Collect and display extra troubleshooting info on leaked connections. |
boolean |
|
||||||||||||||||||||||||||||||
Allows connections to be flushed upon return to the pool. It’s not enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Query executed when first using a connection. |
string |
|||||||||||||||||||||||||||||||
Query executed to validate a connection. |
string |
|||||||||||||||||||||||||||||||
Disable pooling to prevent reuse of Connections. Use this with when an external pool manages the life-cycle of Connections. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present.
If you enable the health check, you must specify the |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The Kafka container image to use.
Only Redpanda and Strimzi images are supported. Default image is Redpanda.
Note that Strimzi images are launched in Kraft mode. In order to use a Strimzi image you need to set a compatible image name such as |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
Timeout for admin client calls used in topic creation. Defaults to 2 seconds. |
|
|||||||||||||||||||||||||||||||
Enables transaction support. Also enables the producer idempotence. Find more info about Red Panda transaction support on https://vectorized.io/blog/fast-transactions/. Notice that KIP-447 (producer scalability for exactly once semantic) and KIP-360 (Improve reliability of idempotent/transactional producer) are not supported. |
boolean |
|
||||||||||||||||||||||||||||||
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, |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present (defaults to true). |
boolean |
|
||||||||||||||||||||||||||||||
A unique identifier for this Kafka Streams application. If not set, defaults to quarkus.application.name. |
string |
|
||||||||||||||||||||||||||||||
A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s). If not set, fallback to |
list of host:port |
|
||||||||||||||||||||||||||||||
A unique identifier of this application instance, typically in the form host:port. |
string |
|||||||||||||||||||||||||||||||
A comma-separated list of topic names. The pipeline will only be started once all these topics are present in the Kafka cluster and |
list of string |
|||||||||||||||||||||||||||||||
Timeout to wait for topic names to be returned from admin client. If set to 0 (or negative), |
|
|||||||||||||||||||||||||||||||
The schema registry key. Different schema registry libraries expect a registry URL in different configuration properties. For Apicurio Registry, use |
string |
|
||||||||||||||||||||||||||||||
The schema registry URL. |
string |
|||||||||||||||||||||||||||||||
The security protocol to use See https://docs.confluent.io/current/streams/developer-guide/security.html#security-example |
string |
|||||||||||||||||||||||||||||||
SASL mechanism used for client connections |
string |
|||||||||||||||||||||||||||||||
JAAS login context parameters for SASL connections in the format used by JAAS configuration files |
string |
|||||||||||||||||||||||||||||||
The fully qualified name of a SASL client callback handler class |
string |
|||||||||||||||||||||||||||||||
The fully qualified name of a SASL login callback handler class |
string |
|||||||||||||||||||||||||||||||
The fully qualified name of a class that implements the Login interface |
string |
|||||||||||||||||||||||||||||||
The Kerberos principal name that Kafka runs as |
string |
|||||||||||||||||||||||||||||||
Kerberos kinit command path |
string |
|||||||||||||||||||||||||||||||
Login thread will sleep until the specified window factor of time from last refresh |
double |
|||||||||||||||||||||||||||||||
Percentage of random jitter added to the renewal time |
double |
|||||||||||||||||||||||||||||||
Percentage of random jitter added to the renewal time |
long |
|||||||||||||||||||||||||||||||
Login refresh thread will sleep until the specified window factor relative to the credential’s lifetime has been reached- |
double |
|||||||||||||||||||||||||||||||
The maximum amount of random jitter relative to the credential’s lifetime |
double |
|||||||||||||||||||||||||||||||
The desired minimum duration for the login refresh thread to wait before refreshing a credential |
||||||||||||||||||||||||||||||||
The amount of buffer duration before credential expiration to maintain when refreshing a credential |
||||||||||||||||||||||||||||||||
The SSL protocol used to generate the SSLContext |
string |
|||||||||||||||||||||||||||||||
The name of the security provider used for SSL connections |
string |
|||||||||||||||||||||||||||||||
A list of cipher suites |
string |
|||||||||||||||||||||||||||||||
The list of protocols enabled for SSL connections |
string |
|||||||||||||||||||||||||||||||
Trust store type |
string |
|||||||||||||||||||||||||||||||
Trust store location |
string |
|||||||||||||||||||||||||||||||
Trust store password |
string |
|||||||||||||||||||||||||||||||
Trust store certificates |
string |
|||||||||||||||||||||||||||||||
Key store type |
string |
|||||||||||||||||||||||||||||||
Key store location |
string |
|||||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||||
Key store private key |
string |
|||||||||||||||||||||||||||||||
Key store certificate chain |
string |
|||||||||||||||||||||||||||||||
Password of the private key in the key store |
string |
|||||||||||||||||||||||||||||||
The algorithm used by key manager factory for SSL connections |
string |
|||||||||||||||||||||||||||||||
The algorithm used by trust manager factory for SSL connections |
string |
|||||||||||||||||||||||||||||||
The endpoint identification algorithm to validate server hostname using server certificate |
string |
|
||||||||||||||||||||||||||||||
The SecureRandom PRNG implementation to use for SSL cryptography operations |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
|
string |
|
||||||||||||||||||||||||||||||
If set to true |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, 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 |
boolean |
|
||||||||||||||||||||||||||||||
The default naming strategy for |
|
|
||||||||||||||||||||||||||||||
The list of selected alternatives for an application.
An element value can be:
- a fully qualified class name, i.e. |
list of string |
|||||||||||||||||||||||||||||||
If set to true then |
boolean |
|
||||||||||||||||||||||||||||||
The list of types that should be excluded from discovery.
An element value can be:
- a fully qualified class name, i.e. |
list of string |
|||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
If set to true then the container monitors business method invocations and fired events during the development mode. |
boolean |
|
||||||||||||||||||||||||||||||
If set to true then disable |
boolean |
|
||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maven groupId of the artifact. |
string |
required |
||||||||||||||||||||||||||||||
The maven artifactId of the artifact. |
string |
required |
||||||||||||||||||||||||||||||
The maven classifier of the artifact. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether or not the cache extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Cache type. |
string |
|
||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
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. |
long |
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The group the container image will be part of |
string |
|
||||||||||||||||||||||||||||||
The name of the container image. If not set defaults to the application name |
string |
|
||||||||||||||||||||||||||||||
The tag of the container image. If not set defaults to the application version |
string |
|
||||||||||||||||||||||||||||||
Additional tags of the container image. |
list of string |
|||||||||||||||||||||||||||||||
The container registry to use |
string |
|||||||||||||||||||||||||||||||
Represents the entire image string. If set, then |
string |
|||||||||||||||||||||||||||||||
The username to use to authenticate with the registry where the built image will be pushed |
string |
|||||||||||||||||||||||||||||||
The password to use to authenticate with the registry where the built image will be pushed |
string |
|||||||||||||||||||||||||||||||
Whether or not insecure registries are allowed |
boolean |
|
||||||||||||||||||||||||||||||
Whether or not a image build will be performed. |
boolean |
|||||||||||||||||||||||||||||||
Whether or not an image push will be performed. |
boolean |
|||||||||||||||||||||||||||||||
The name of the container image extension to use (e.g. docker, jib, s2i). The option will be used in case multiple extensions are present. |
string |
|||||||||||||||||||||||||||||||
Custom labels to add to the generated image. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The buildpacks builder image to use when building the project in jvm mode. |
string |
|||||||||||||||||||||||||||||||
The buildpacks builder image to use when building the project in jvm mode. |
string |
|||||||||||||||||||||||||||||||
The buildpacks run image to use when building the project When not supplied, the run image is determined by the builder image. |
string |
|||||||||||||||||||||||||||||||
Max pull timeout for builder/run images, in seconds |
int |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Log level to use.. Defaults to 'info' |
string |
|
||||||||||||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image |
string |
|||||||||||||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image |
string |
|||||||||||||||||||||||||||||||
Environment key/values to pass to buildpacks. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Path to the JVM Dockerfile. If not set ${project.root}/src/main/docker/Dockerfile.jvm will be used If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root |
string |
|||||||||||||||||||||||||||||||
Path to the JVM Dockerfile. If not set ${project.root}/src/main/docker/Dockerfile.native will be used If set to an absolute path then the absolute path will be used, otherwise the path will be considered relative to the project root |
string |
|||||||||||||||||||||||||||||||
Images to consider as cache sources. Values are passed to |
list of string |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Name of binary used to execute the docker commands. |
string |
|
||||||||||||||||||||||||||||||
Build args passed to docker via |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Which platform(s) to target during the build. See https://docs.docker.com/engine/reference/commandline/buildx_build/#platform |
list of string |
|||||||||||||||||||||||||||||||
Sets the export action for the build result. See https://docs.docker.com/engine/reference/commandline/buildx_build/#output. Note that any filesystem paths need to be absolute paths, not relative from where the command is executed from. |
string |
|||||||||||||||||||||||||||||||
Set type of progress output ( |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application |
list of string |
|
||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application |
list of string |
|||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application |
list of string |
|||||||||||||||||||||||||||||||
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
- A valid entrypoint is jar package specific (see |
list of string |
|||||||||||||||||||||||||||||||
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
- 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 |
list of string |
|||||||||||||||||||||||||||||||
The username to use to authenticate with the registry used to pull the base JVM image |
string |
|||||||||||||||||||||||||||||||
The password to use to authenticate with the registry used to pull the base JVM image |
string |
|||||||||||||||||||||||||||||||
The ports to expose |
list of int |
|
||||||||||||||||||||||||||||||
The user to use in generated image |
string |
|||||||||||||||||||||||||||||||
The working directory to use in the generated image. The default value is chosen to work in accordance with the default base image. |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
List of target platforms. Each platform is defined using the pattern: |
list of string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
Whether or not to operate offline. |
boolean |
|
||||||||||||||||||||||||||||||
Name of binary used to execute the docker commands. This is only used by Jib when the container image is being built locally. |
string |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Environment variables to add to the container image |
|
|||||||||||||||||||||||||||||||
Sets environment variables used by the Docker executable. This is only used by Jib when the container image is being built locally. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The build config strategy to use. |
|
|
||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, |
string |
|||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build |
string |
|
||||||||||||||||||||||||||||||
The default Dockerfile to use for jvm builds |
string |
|
||||||||||||||||||||||||||||||
The default Dockerfile to use for native builds |
string |
|
||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application |
list of string |
|
||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application |
list of string |
|||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application |
list of string |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
The build timeout. |
|
|||||||||||||||||||||||||||||||
The build config strategy to use. |
|
|
||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build. When the application is built against Java 17 or higher, |
string |
|||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build |
string |
|
||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application |
list of string |
|
||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application |
list of string |
|||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application |
list of string |
|
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
The build timeout. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the jar build |
string |
|||||||||||||||||||||||||||||||
The base image to be used when a container image is being produced for the native binary build |
string |
|
||||||||||||||||||||||||||||||
The JVM arguments to pass to the JVM when starting the application |
list of string |
|
||||||||||||||||||||||||||||||
Additional JVM arguments to pass to the JVM when starting the application |
list of string |
|||||||||||||||||||||||||||||||
Additional arguments to pass when starting the native application |
list of string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
The build timeout. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. |
string |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The container start command to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. |
string |
|||||||||||||||||||||||||||||||
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). |
boolean |
|
||||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. This is a global setting and is not specific to a datasource. |
boolean |
|
||||||||||||||||||||||||||||||
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. NOTE: 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. |
boolean |
|
||||||||||||||||||||||||||||||
The datasource username |
string |
|||||||||||||||||||||||||||||||
The datasource password |
string |
|||||||||||||||||||||||||||||||
The credentials provider name |
string |
|||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the |
string |
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Generic properties that are added to the database connection URL. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. |
string |
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Generic properties that are added to the database connection URL. |
|
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The container start command to use, for container based DevServices providers. If the provider is not container based (e.g. a H2 Database) then this has no effect. |
string |
|||||||||||||||||||||||||||||||
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). |
boolean |
|
||||||||||||||||||||||||||||||
The datasource username |
string |
|||||||||||||||||||||||||||||||
The datasource password |
string |
|||||||||||||||||||||||||||||||
The credentials provider name |
string |
|||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enables or disables the Vert.x cache. |
boolean |
|
||||||||||||||||||||||||||||||
Enables or disabled the Vert.x classpath resource resolver. |
boolean |
|
||||||||||||||||||||||||||||||
The number of event loops. 2 x the number of core by default. |
int |
|||||||||||||||||||||||||||||||
The maximum amount of time the event loop can be blocked. |
|
|||||||||||||||||||||||||||||||
The amount of time before a warning is displayed if the event loop is blocked. |
|
|||||||||||||||||||||||||||||||
The size of the worker thread pool. |
int |
|
||||||||||||||||||||||||||||||
The maximum amount of time the worker thread can be blocked. |
|
|||||||||||||||||||||||||||||||
The size of the internal thread pool (used for the file system). |
int |
|
||||||||||||||||||||||||||||||
The queue size. For most applications this should be unbounded |
int |
|||||||||||||||||||||||||||||||
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 |
float |
|
||||||||||||||||||||||||||||||
The amount of time a thread will stay alive with no work. |
|
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Enables the async DNS resolver. |
boolean |
|
||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
The accept backlog. |
int |
|||||||||||||||||||||||||||||||
The client authentication. |
string |
|
||||||||||||||||||||||||||||||
The connect timeout. |
|
|||||||||||||||||||||||||||||||
The idle timeout in milliseconds. |
||||||||||||||||||||||||||||||||
The receive buffer size. |
int |
|||||||||||||||||||||||||||||||
The number of reconnection attempts. |
int |
|
||||||||||||||||||||||||||||||
The reconnection interval in milliseconds. |
|
|||||||||||||||||||||||||||||||
Whether to reuse the address. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to reuse the port. |
boolean |
|
||||||||||||||||||||||||||||||
The send buffer size. |
int |
|||||||||||||||||||||||||||||||
The so linger. |
int |
|||||||||||||||||||||||||||||||
Enables or Disabled SSL. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to keep the TCP connection opened (keep-alive). |
boolean |
|
||||||||||||||||||||||||||||||
Configure the TCP no delay. |
boolean |
|
||||||||||||||||||||||||||||||
Configure the traffic class. |
int |
|||||||||||||||||||||||||||||||
Enables or disables the trust all parameter. |
boolean |
|
||||||||||||||||||||||||||||||
The host name. |
string |
|
||||||||||||||||||||||||||||||
The port. |
int |
|||||||||||||||||||||||||||||||
The public host name. |
string |
|||||||||||||||||||||||||||||||
The public port. |
int |
|||||||||||||||||||||||||||||||
Enables or disables the clustering. |
boolean |
|
||||||||||||||||||||||||||||||
The ping interval. |
|
|||||||||||||||||||||||||||||||
The ping reply interval. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
The minimum amount of time in seconds that a successfully resolved address will be cached. |
int |
|
||||||||||||||||||||||||||||||
The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of queries to be sent during a resolution. |
int |
|
||||||||||||||||||||||||||||||
The duration after which a DNS query is considered to be failed. |
|
|||||||||||||||||||||||||||||||
Enable or disable native transport |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The number of history log entries to remember. |
int |
|
||||||||||||||||||||||||||||||
The HTTP root path. All web content will be served relative to this 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. If no authentication mechanisms are configured basic auth is the default. |
boolean |
|||||||||||||||||||||||||||||||
If form authentication is enabled |
boolean |
|
||||||||||||||||||||||||||||||
The login page |
string |
|
||||||||||||||||||||||||||||||
The post location. |
string |
|
||||||||||||||||||||||||||||||
The username field name. |
string |
|
||||||||||||||||||||||||||||||
The password field name. |
string |
|
||||||||||||||||||||||||||||||
The error page |
string |
|
||||||||||||||||||||||||||||||
The landing page to redirect to if there is no saved page to redirect back to |
string |
|
||||||||||||||||||||||||||||||
Option to disable redirect to landingPage if there is no saved page to redirect back to. Form Auth POST is followed by redirect to landingPage by default. |
boolean |
|
||||||||||||||||||||||||||||||
Option to control the name of the cookie used to redirect the user back to where he wants to get access to. |
string |
|
||||||||||||||||||||||||||||||
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced. |
|
|||||||||||||||||||||||||||||||
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 as 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 users last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request, as the timeout is only refreshed when a new cookie is generated. In other words 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. |
|
|||||||||||||||||||||||||||||||
The cookie that is used to store the persistent session |
string |
|
||||||||||||||||||||||||||||||
The authentication realm |
string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED |
|
|
||||||||||||||||||||||||||||||
If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. |
boolean |
|
||||||||||||||||||||||||||||||
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.
|
string |
|
||||||||||||||||||||||||||||||
The REST Assured client timeout for testing. |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
List of media types for which the compression should be enabled automatically, unless declared explicitly via |
list of string |
|
||||||||||||||||||||||||||||||
The compression level used when compression support is enabled. |
int |
|||||||||||||||||||||||||||||||
Enable the CORS filter. |
boolean |
|
||||||||||||||||||||||||||||||
The HTTP port |
int |
|
||||||||||||||||||||||||||||||
The HTTP port used to run tests |
int |
|
||||||||||||||||||||||||||||||
The HTTP host 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. |
string |
required |
||||||||||||||||||||||||||||||
Enable listening to host:port |
boolean |
|
||||||||||||||||||||||||||||||
The HTTPS port |
int |
|
||||||||||||||||||||||||||||||
The HTTPS port used to run tests |
int |
|
||||||||||||||||||||||||||||||
If insecure (i.e. http rather than https) requests are allowed. If this is |
|
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. The filter allows any origin if this is not set. default: returns any requested origin as valid |
list of string |
|||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty |
list of string |
|||||||||||||||||||||||||||||||
The |
||||||||||||||||||||||||||||||||
The |
boolean |
|||||||||||||||||||||||||||||||
The list of path to server certificates using the PEM format. Specifying multiple files require SNI to be enabled. |
list of path |
|||||||||||||||||||||||||||||||
The list of path to server certificates private key file using the PEM format. Specifying multiple files require SNI to be enabled. The order of the key files must match the order of the certificates. |
list of path |
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from |
string |
|||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to trust only one specific certificate in the trust store (instead of trusting all certificates in the store). |
string |
|||||||||||||||||||||||||||||||
The cipher suites to use. If none is given, a reasonable default is selected. |
list of string |
|||||||||||||||||||||||||||||||
The list of protocols to explicitly enable. |
list of string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
When set to |
boolean |
|
||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
The maximum length of all headers. |
|
|||||||||||||||||||||||||||||||
The maximum size of a request body. |
|
|||||||||||||||||||||||||||||||
The max HTTP chunk size |
|
|||||||||||||||||||||||||||||||
The maximum length of the initial line (e.g. |
int |
|
||||||||||||||||||||||||||||||
The maximum length of a form attribute. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Http connection idle 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. |
|
|||||||||||||||||||||||||||||||
Whether the files sent using |
boolean |
|
||||||||||||||||||||||||||||||
The directory where the files sent using |
string |
|
||||||||||||||||||||||||||||||
Whether the form attributes should be added to the request parameters.
If |
boolean |
|
||||||||||||||||||||||||||||||
Whether the uploaded files should be removed after serving the request.
If |
boolean |
|
||||||||||||||||||||||||||||||
Whether the body buffer should pre-allocated based on the |
boolean |
|
||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
Enable socket reuse port (linux/macOs native transport only) |
boolean |
|
||||||||||||||||||||||||||||||
Enable tcp quick ack (linux native transport only) |
boolean |
|
||||||||||||||||||||||||||||||
Enable tcp cork (linux native transport only) |
boolean |
|
||||||||||||||||||||||||||||||
Enable tcp fast open (linux native transport only) |
boolean |
|
||||||||||||||||||||||||||||||
The accept backlog, this is how many connections can be waiting to be accepted before connections start being rejected |
int |
|
||||||||||||||||||||||||||||||
Path to a unix domain socket |
string |
|
||||||||||||||||||||||||||||||
Enable listening to host:port |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
If access logging is enabled. By default this will log via the standard logging facility |
boolean |
|
||||||||||||||||||||||||||||||
A regular expression that can be used to exclude some paths from logging. |
string |
|||||||||||||||||||||||||||||||
The access log pattern. If this is the string
Otherwise, consult the Quarkus documentation for the full list of variables that can be used. |
string |
|
||||||||||||||||||||||||||||||
If logging should be done to a separate file. |
boolean |
|
||||||||||||||||||||||||||||||
The access log file base name, defaults to 'quarkus' which will give a log file name of 'quarkus.log'. |
string |
|
||||||||||||||||||||||||||||||
The log directory to use when logging access to a file If this is not set then the current working directory is used. |
string |
|||||||||||||||||||||||||||||||
The log file suffix |
string |
|
||||||||||||||||||||||||||||||
The log category to use if logging is being done via the standard log mechanism (i.e. if base-file-name is empty). |
string |
|
||||||||||||||||||||||||||||||
If the log should be rotated daily |
boolean |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
If this is true then the address, scheme etc. will be set from headers forwarded by the proxy server, such as |
boolean |
|
||||||||||||||||||||||||||||||
If this is true and proxy address forwarding is enabled then the standard |
boolean |
|
||||||||||||||||||||||||||||||
If either this or |
boolean |
|||||||||||||||||||||||||||||||
Enable override the received request’s host through a forwarded host header. |
boolean |
|
||||||||||||||||||||||||||||||
Configure the forwarded host header to be used if override enabled. |
string |
|
||||||||||||||||||||||||||||||
Enable prefix the received request’s path with a forwarded prefix header. |
boolean |
|
||||||||||||||||||||||||||||||
Configure the forwarded prefix header to be used if prefixing enabled. |
string |
|
||||||||||||||||||||||||||||||
Determines whether the entire permission set is enabled, or not. By default, if the permission set is defined, it is enabled. |
boolean |
|||||||||||||||||||||||||||||||
The HTTP policy that this permission set is linked to. There are 3 built in policies: permit, deny and authenticated. Role based policies can be defined, and extensions can add their own policies. |
string |
required |
||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
Path specific authentication mechanism which must be used to authenticate a user. It needs to match |
string |
|||||||||||||||||||||||||||||||
The roles that are allowed to access resources protected by this policy |
list of string |
required |
||||||||||||||||||||||||||||||
If the cookie pattern is case-sensitive |
boolean |
|
||||||||||||||||||||||||||||||
The value to set in the samesite attribute |
|
required |
||||||||||||||||||||||||||||||
Some User Agents break when sent SameSite=None, this will detect them and avoid sending the value |
boolean |
|
||||||||||||||||||||||||||||||
If this is true then the 'secure' attribute will automatically be sent on cookies with a SameSite attribute of None. |
boolean |
|
||||||||||||||||||||||||||||||
The path this header should be applied |
string |
|
||||||||||||||||||||||||||||||
The value for this header configuration |
string |
required |
||||||||||||||||||||||||||||||
The HTTP methods for this header configuration |
list of string |
|||||||||||||||||||||||||||||||
A regular expression for the paths matching this configuration |
string |
required |
||||||||||||||||||||||||||||||
Additional HTTP Headers always sent in the response |
|
|||||||||||||||||||||||||||||||
The HTTP methods for this path configuration |
list of string |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If GraphQL UI should be included every time. By default, this is only included when the application is running in dev mode. |
boolean |
|
||||||||||||||||||||||||||||||
The path where GraphQL UI is available.
The value |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If Dev Services for Elasticsearch has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Elasticsearch, Dev Services starts a server unless |
boolean |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The Elasticsearch container image to use. Defaults to the elasticsearch image provided by Elastic. |
string |
|
||||||||||||||||||||||||||||||
The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 1GB. |
string |
|
||||||||||||||||||||||||||||||
Indicates if 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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. |
list of host:port |
|
||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. |
string |
|
||||||||||||||||||||||||||||||
The username for basic HTTP authentication. |
string |
|||||||||||||||||||||||||||||||
The password for basic HTTP authentication. |
string |
|||||||||||||||||||||||||||||||
The connection timeout. |
|
|||||||||||||||||||||||||||||||
The socket timeout. |
|
|||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Refresh interval of the node list. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The realm name |
string |
|
||||||||||||||||||||||||||||||
If the properties store is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The sql query to find the password |
string |
|||||||||||||||||||||||||||||||
The data source to use |
string |
|||||||||||||||||||||||||||||||
If the clear-password-mapper is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the clear password |
int |
|
||||||||||||||||||||||||||||||
If the bcrypt-password-mapper is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the password hash |
int |
|
||||||||||||||||||||||||||||||
A string referencing the password hash encoding ("BASE64" or "HEX") |
|
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt salt |
int |
|
||||||||||||||||||||||||||||||
A string referencing the salt encoding ("BASE64" or "HEX") |
|
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt iteration count |
int |
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of column to map |
int |
|
||||||||||||||||||||||||||||||
The target attribute name |
string |
required |
||||||||||||||||||||||||||||||
The sql query to find the password |
string |
|||||||||||||||||||||||||||||||
The data source to use |
string |
|||||||||||||||||||||||||||||||
The index (1 based numbering) of column to map |
int |
|
||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
If the clear-password-mapper is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the clear password |
int |
|
||||||||||||||||||||||||||||||
If the bcrypt-password-mapper is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the password hash |
int |
|
||||||||||||||||||||||||||||||
A string referencing the password hash encoding ("BASE64" or "HEX") |
|
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt salt |
int |
|
||||||||||||||||||||||||||||||
A string referencing the salt encoding ("BASE64" or "HEX") |
|
|
||||||||||||||||||||||||||||||
The index (1 based numbering) of the column containing the Bcrypt iteration count |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The option to enable the ldap elytron module |
boolean |
|
||||||||||||||||||||||||||||||
The elytron realm name |
string |
|
||||||||||||||||||||||||||||||
Provided credentials are verified against ldap? |
boolean |
|
||||||||||||||||||||||||||||||
The url of the ldap server |
string |
required |
||||||||||||||||||||||||||||||
The principal: user which is used to connect to ldap server (also named "bindDn") |
string |
|||||||||||||||||||||||||||||||
The password which belongs to the principal (also named "bindCredential") |
string |
|||||||||||||||||||||||||||||||
how ldap redirects are handled |
|
|
||||||||||||||||||||||||||||||
The connect timeout |
|
|||||||||||||||||||||||||||||||
The read timeout |
|
|||||||||||||||||||||||||||||||
The identifier which correlates to the provided user (also named "baseFilter") |
string |
|
||||||||||||||||||||||||||||||
The dn where we look for users |
string |
required |
||||||||||||||||||||||||||||||
If the child nodes are also searched for identities |
boolean |
|
||||||||||||||||||||||||||||||
The roleAttributeId from which is mapped (e.g. "cn") |
string |
required |
||||||||||||||||||||||||||||||
The identifier whom the attribute is mapped to (in Quarkus: "groups", in WildFly this is "Roles") |
string |
|
||||||||||||||||||||||||||||||
The filter (also named "roleFilter") |
string |
required |
||||||||||||||||||||||||||||||
The filter base dn (also named "rolesContextDn") |
string |
required |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Determine if the OAuth2 extension is enabled. Enabled by default if you include the |
boolean |
|
||||||||||||||||||||||||||||||
The claim that is used in the introspection endpoint response to load the roles. |
string |
|
||||||||||||||||||||||||||||||
The OAuth2 client id used to validate the token. Mandatory if the extension is enabled. |
string |
|||||||||||||||||||||||||||||||
The OAuth2 client secret used to validate the token. Mandatory if the extension is enabled. |
string |
|||||||||||||||||||||||||||||||
The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims. Mandatory if the extension is enabled. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 ) ) |
boolean |
|
||||||||||||||||||||||||||||||
Determine which algorithm to use.
This property is ignored if |
|
|
||||||||||||||||||||||||||||||
The realm users user1=password\nuser2=password2… mapping. See Embedded Users. |
|
|
||||||||||||||||||||||||||||||
The realm roles user1=role1,role2,…\nuser2=role1,role2,… mapping See Embedded Roles. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The realm name. This is used when generating a hashed password |
string |
|
||||||||||||||||||||||||||||||
Determine whether security via the file realm is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
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 ) ) |
boolean |
|
||||||||||||||||||||||||||||||
Classpath resource name of properties file containing user to password mappings. See Users.properties. |
string |
|
||||||||||||||||||||||||||||||
Classpath resource name of properties file containing user to role mappings. See Roles.properties. |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The realm name. This is used when generating a hashed password |
string |
|
||||||||||||||||||||||||||||||
Determine whether security via the embedded realm is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
list of string |
|
||||||||||||||||||||||||||||||
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The |
list of string |
|||||||||||||||||||||||||||||||
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. |
int |
|||||||||||||||||||||||||||||||
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. Consequences: - This schema will be the one containing the schema history table. - This schema will be the default for the database connection (provided the database supports this concept). |
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. |
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. |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
true to execute Flyway clean command automatically when the application starts, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to prevent Flyway clean operations, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to automatically call clean when a validation error occurs, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to execute Flyway automatically when the application starts, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
Enable the creation of the history table if it does not exist already. |
boolean |
|
||||||||||||||||||||||||||||||
The initial baseline version. |
string |
|||||||||||||||||||||||||||||||
The description to tag an existing schema with when executing baseline. |
string |
|||||||||||||||||||||||||||||||
Whether to automatically call validate when performing a migration. |
boolean |
|
||||||||||||||||||||||||||||||
Allows migrations to be run "out of order". |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Whether Flyway should attempt to create the schemas specified in the schemas property |
boolean |
|
||||||||||||||||||||||||||||||
Prefix of every placeholder (default: ${ ) |
string |
|||||||||||||||||||||||||||||||
Suffix of every placeholder (default: } ) |
string |
|||||||||||||||||||||||||||||||
The SQL statements to run to initialize a new database connection immediately after opening it. |
string |
|||||||||||||||||||||||||||||||
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. |
list of string |
|
||||||||||||||||||||||||||||||
Comma-separated list of fully qualified class names of Callback implementations to use to hook into the Flyway lifecycle. The |
list of string |
|||||||||||||||||||||||||||||||
Sets the placeholders to replace in SQL migration scripts. |
|
|||||||||||||||||||||||||||||||
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries. |
int |
|||||||||||||||||||||||||||||||
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. Consequences: - This schema will be the one containing the schema history table. - This schema will be the default for the database connection (provided the database supports this concept). |
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. |
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. |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
true to execute Flyway clean command automatically when the application starts, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to prevent Flyway clean operations, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to automatically call clean when a validation error occurs, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
true to execute Flyway automatically when the application starts, false otherwise. |
boolean |
|
||||||||||||||||||||||||||||||
Enable the creation of the history table if it does not exist already. |
boolean |
|
||||||||||||||||||||||||||||||
The initial baseline version. |
string |
|||||||||||||||||||||||||||||||
The description to tag an existing schema with when executing baseline. |
string |
|||||||||||||||||||||||||||||||
Whether to automatically call validate when performing a migration. |
boolean |
|
||||||||||||||||||||||||||||||
Allows migrations to be run "out of order". |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Sets the placeholders to replace in SQL migration scripts. |
|
|||||||||||||||||||||||||||||||
Whether Flyway should attempt to create the schemas specified in the schemas property |
boolean |
|
||||||||||||||||||||||||||||||
Prefix of every placeholder (default: ${ ) |
string |
|||||||||||||||||||||||||||||||
Suffix of every placeholder (default: } ) |
string |
|||||||||||||||||||||||||||||||
The SQL statements to run to initialize a new database connection immediately after opening it. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
If function has response output, then what is the Cloud Event type (ce-type)? This will default to {function}.output |
string |
|||||||||||||||||||||||||||||||
If function has response output, then what is the Cloud Event source (ce-source)? This will default to the function name |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The function name. Function names are specified on function classes using the |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enable store_data_at_delete feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Defines a suffix for historical data table. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Defines a prefix for historical data table. Default is the empty string. Maps to |
string |
|||||||||||||||||||||||||||||||
Revision field name. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Revision type field name. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Enable the revision_on_collection_change feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Enable the do_not_audit_optimistic_locking_field feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Defines the default schema of where audit tables are to be created. Maps to |
string |
|||||||||||||||||||||||||||||||
Defines the default catalog of where audit tables are to be created. Maps to |
string |
|||||||||||||||||||||||||||||||
Enables the track_entities_changed_in_revision feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Enables the use_revision_entity_with_native_id feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Enables the global_with_modified_flag feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Defines the suffix to be used for modified flag columns. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Defines the fully qualified class name of a user defined revision listener. Maps to |
string |
|||||||||||||||||||||||||||||||
Defines the fully qualified class name of the audit strategy to be used. Maps to |
string |
|
||||||||||||||||||||||||||||||
Defines the property name for the audit entity’s composite primary key. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Defines the column name that holds the end revision number in audit entities. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Enables the audit_strategy_validity_store_revend_timestamp feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Defines the column name of the revision end timestamp in the audit tables. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Defines the name of the column used for storing collection ordinal values for embeddable elements. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Enables the allow_identifier_reuse feature. Maps to |
boolean |
|
||||||||||||||||||||||||||||||
Defines the naming strategy to be used for modified columns. Defaults to |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
Path to a file containing the SQL statements to execute when Hibernate ORM starts. The file is retrieved from the classpath resources,
so it must be located in the resources directory (e.g. The default value for this setting differs depending on the Quarkus launch mode:
If you need different SQL statements between dev mode, test ( application.properties
|
list of string |
|
||||||||||||||||||||||||||||||
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation |
string |
|||||||||||||||||||||||||||||||
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation |
string |
|||||||||||||||||||||||||||||||
Class name of a custom
|
string |
|||||||||||||||||||||||||||||||
XML files to configure the entity mapping, e.g. |
list of string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false. |
boolean |
|||||||||||||||||||||||||||||||
Whether session metrics should be appended into the server log for each Hibernate session. This only has effect if statistics are enabled ( |
boolean |
|||||||||||||||||||||||||||||||
Whether metrics are published if a metrics extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the Hibernate ORM JavaDoc.
|
string |
|||||||||||||||||||||||||||||||
The storage engine to use when the dialect supports multiple storage engines. E.g. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum size of the query plan cache. see # |
int |
|
||||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. |
|
|||||||||||||||||||||||||||||||
Whether Hibernate should quote all identifiers. |
boolean |
|
||||||||||||||||||||||||||||||
Select whether the database schema is generated or not. |
string |
|
||||||||||||||||||||||||||||||
If Hibernate ORM should create the schemas automatically (for databases supporting them). |
boolean |
|
||||||||||||||||||||||||||||||
Whether we should stop on the first error when applying the schema. |
boolean |
|
||||||||||||||||||||||||||||||
The default catalog to use for the database objects. |
string |
|||||||||||||||||||||||||||||||
The default schema to use for the database objects. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The time zone pushed to the JDBC driver. |
string |
|||||||||||||||||||||||||||||||
How many rows are fetched at a time by the JDBC driver. |
int |
|||||||||||||||||||||||||||||||
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The size of the batches used when loading entities and collections.
|
int |
|
||||||||||||||||||||||||||||||
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). A |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum time before an object of the cache is considered expired. |
||||||||||||||||||||||||||||||||
The maximum number of objects kept in memory in the cache. |
long |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
Path to a file containing the SQL statements to execute when Hibernate ORM starts. The file is retrieved from the classpath resources,
so it must be located in the resources directory (e.g. The default value for this setting differs depending on the Quarkus launch mode:
If you need different SQL statements between dev mode, test ( application.properties
|
list of string |
|
||||||||||||||||||||||||||||||
Pluggable strategy contract for applying physical naming rules for database object names. Class name of the Hibernate PhysicalNamingStrategy implementation |
string |
|||||||||||||||||||||||||||||||
Pluggable strategy for applying implicit naming rules when an explicit name is not given. Class name of the Hibernate ImplicitNamingStrategy implementation |
string |
|||||||||||||||||||||||||||||||
Class name of a custom
|
string |
|||||||||||||||||||||||||||||||
XML files to configure the entity mapping, e.g. |
list of string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
Defines the name of the datasource to use in case of SCHEMA approach. The datasource of the persistence unit will be used if not set. |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Class name of the Hibernate ORM dialect. The complete list of bundled dialects is available in the Hibernate ORM JavaDoc.
|
string |
|||||||||||||||||||||||||||||||
The storage engine to use when the dialect supports multiple storage engines. E.g. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum size of the query plan cache. see # |
int |
|
||||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. |
|
|||||||||||||||||||||||||||||||
Whether Hibernate should quote all identifiers. |
boolean |
|
||||||||||||||||||||||||||||||
Select whether the database schema is generated or not. |
string |
|
||||||||||||||||||||||||||||||
If Hibernate ORM should create the schemas automatically (for databases supporting them). |
boolean |
|
||||||||||||||||||||||||||||||
Whether we should stop on the first error when applying the schema. |
boolean |
|
||||||||||||||||||||||||||||||
The default catalog to use for the database objects. |
string |
|||||||||||||||||||||||||||||||
The default schema to use for the database objects. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The time zone pushed to the JDBC driver. |
string |
|||||||||||||||||||||||||||||||
How many rows are fetched at a time by the JDBC driver. |
int |
|||||||||||||||||||||||||||||||
The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution. |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The size of the batches used when loading entities and collections.
|
int |
|
||||||||||||||||||||||||||||||
The maximum depth of outer join fetch tree for single-ended associations (one-to-one, many-to-one). A |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum time before an object of the cache is considered expired. |
||||||||||||||||||||||||||||||||
The maximum number of objects kept in memory in the cache. |
long |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Select whether the database schema DDL files are generated or not. Accepted values: |
string |
|
||||||||||||||||||||||||||||||
Filename or URL where the database create DDL file should be generated. |
string |
|||||||||||||||||||||||||||||||
Filename or URL where the database drop DDL file should be generated. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production. |
boolean |
|
||||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. |
boolean |
|
||||||||||||||||||||||||||||||
If set, Hibernate will log queries that took more than specified number of milliseconds to execute. |
long |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Logs SQL bind parameters. Setting it to true is obviously not recommended in production. |
boolean |
|
||||||||||||||||||||||||||||||
Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production. |
boolean |
|
||||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. |
boolean |
|
||||||||||||||||||||||||||||||
If set, Hibernate will log queries that took more than specified number of milliseconds to execute. |
long |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Select whether the database schema DDL files are generated or not. Accepted values: |
string |
|
||||||||||||||||||||||||||||||
Filename or URL where the database create DDL file should be generated. |
string |
|||||||||||||||||||||||||||||||
Filename or URL where the database drop DDL file should be generated. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
The strategy to use for coordinating between threads or even separate instances of the application, in particular in automatic indexing. See [coordination] for more information. |
string |
|
||||||||||||||||||||||||||||||
Whether Hibernate Search is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The schema management strategy, controlling how indexes and their schema are created, updated, validated or dropped on startup and shutdown. Available values:
See this section of the reference documentation for more information. |
|
|
||||||||||||||||||||||||||||||
The strategy to use when loading entities during the execution of a search query. |
|
|
||||||||||||||||||||||||||||||
The fetch size to use when loading entities during the execution of a search query. |
int |
|
||||||||||||||||||||||||||||||
The synchronization strategy to use when indexing automatically. Defines how complete indexing should be before resuming the application thread after a database transaction is committed.
Available values:
This property also accepts a bean reference
to a custom implementations of See this section of the reference documentation for more information. |
string |
|
||||||||||||||||||||||||||||||
Whether to check if dirty properties are relevant to indexing before actually reindexing an entity. When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing. |
boolean |
|
||||||||||||||||||||||||||||||
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.
Mainly useful when using the |
list of string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
ElasticsearchVersion |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure layout (e.g. index names, index aliases). The referenced bean must implement Available built-in implementations:
See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. |
list of string |
|
||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. |
|
|
||||||||||||||||||||||||||||||
The username used for authentication. |
string |
|||||||||||||||||||||||||||||||
The password used for authentication. |
string |
|||||||||||||||||||||||||||||||
The timeout when establishing a connection to an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
The timeout when reading responses from an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. |
int |
|
||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Refresh interval of the node list. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to |
boolean |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
ElasticsearchVersion |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure layout (e.g. index names, index aliases). The referenced bean must implement Available built-in implementations:
See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. |
list of string |
|
||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. |
|
|
||||||||||||||||||||||||||||||
The username used for authentication. |
string |
|||||||||||||||||||||||||||||||
The password used for authentication. |
string |
|||||||||||||||||||||||||||||||
The timeout when establishing a connection to an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
The timeout when reading responses from an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. |
int |
|
||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Refresh interval of the node list. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to |
boolean |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
The strategy to use for coordinating between threads or even separate instances of the application, in particular in automatic indexing. See [coordination] for more information. |
string |
|
||||||||||||||||||||||||||||||
Whether Hibernate Search is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The schema management strategy, controlling how indexes and their schema are created, updated, validated or dropped on startup and shutdown. Available values:
See this section of the reference documentation for more information. |
|
|
||||||||||||||||||||||||||||||
The strategy to use when loading entities during the execution of a search query. |
|
|
||||||||||||||||||||||||||||||
The fetch size to use when loading entities during the execution of a search query. |
int |
|
||||||||||||||||||||||||||||||
The synchronization strategy to use when indexing automatically. Defines how complete indexing should be before resuming the application thread after a database transaction is committed.
Available values:
This property also accepts a bean reference
to a custom implementations of See this section of the reference documentation for more information. |
string |
|
||||||||||||||||||||||||||||||
Whether to check if dirty properties are relevant to indexing before actually reindexing an entity. When enabled, re-indexing of an entity is skipped if the only changes are on properties that are not used when indexing. |
boolean |
|
||||||||||||||||||||||||||||||
An exhaustive list of all tenant identifiers that may be used by the application when multi-tenancy is enabled.
Mainly useful when using the |
list of string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
ElasticsearchVersion |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure layout (e.g. index names, index aliases). The referenced bean must implement Available built-in implementations:
See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. |
list of string |
|
||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. |
|
|
||||||||||||||||||||||||||||||
The username used for authentication. |
string |
|||||||||||||||||||||||||||||||
The password used for authentication. |
string |
|||||||||||||||||||||||||||||||
The timeout when establishing a connection to an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
The timeout when reading responses from an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. |
int |
|
||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Refresh interval of the node list. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to |
boolean |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
ElasticsearchVersion |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure layout (e.g. index names, index aliases). The referenced bean must implement Available built-in implementations:
See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
string |
|||||||||||||||||||||||||||||||
A bean reference to the component used to configure full text analysis (e.g. analyzers, normalizers). The referenced bean must implement See [analysis-configurer] for more information. |
string |
|||||||||||||||||||||||||||||||
The list of hosts of the Elasticsearch servers. |
list of string |
|
||||||||||||||||||||||||||||||
The protocol to use when contacting Elasticsearch servers. Set to "https" to enable SSL/TLS. |
|
|
||||||||||||||||||||||||||||||
The username used for authentication. |
string |
|||||||||||||||||||||||||||||||
The password used for authentication. |
string |
|||||||||||||||||||||||||||||||
The timeout when establishing a connection to an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
The timeout when reading responses from an Elasticsearch server. |
|
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The maximum number of connections to all the Elasticsearch servers. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of connections per Elasticsearch server. |
int |
|
||||||||||||||||||||||||||||||
Defines if automatic discovery is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Refresh interval of the node list. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Whether Hibernate Search should check the version of the Elasticsearch cluster on startup.
Set to |
boolean |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
The minimal cluster status required. |
|
|
||||||||||||||||||||||||||||||
How long we should wait for the status before failing the bootstrap. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
boolean |
|
||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
int |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
list of int |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
int |
|
||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
||||||||||||||||||||||||||||||||
How long the event processor must wait before re-processing an event after its previous processing failed. Use the value See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
boolean |
|
||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
int |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
list of int |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
int |
|
||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
||||||||||||||||||||||||||||||||
How long the event processor must wait before re-processing an event after its previous processing failed. Use the value See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
boolean |
|
||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
int |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
list of int |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
int |
|
||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
||||||||||||||||||||||||||||||||
How long the event processor must wait before re-processing an event after its previous processing failed. Use the value See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
boolean |
|
||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
int |
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information about event processor sharding. |
list of int |
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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 See this section of the reference documentation for more information. |
int |
|
||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
||||||||||||||||||||||||||||||||
How long the event processor must wait before re-processing an event after its previous processing failed. Use the value See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
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. See this section of the reference documentation for more information. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enable the fail fast mode. When fail fast is enabled the validation will stop on the first constraint violation detected. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Define whether overriding methods that override constraints should throw a |
boolean |
|
||||||||||||||||||||||||||||||
Define whether parallel methods that define constraints should throw a |
boolean |
|
||||||||||||||||||||||||||||||
Define whether more than one constraint on a return value may be marked for cascading validation are allowed. The default value is |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode and when Docker is running. |
boolean |
|
||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
Sets the bounded entry count for near cache. If this value is 0 or less near cache is disabled. |
int |
|
||||||||||||||||||||||||||||||
Sets the host name/port to connect to. Each one is separated by a semicolon (eg. host1:11222;host2:11222). |
string |
|||||||||||||||||||||||||||||||
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'. |
boolean |
|
||||||||||||||||||||||||||||||
Sets client intelligence used by authentication Available values: * |
string |
|
||||||||||||||||||||||||||||||
Enables or disables authentication. Set it to false when connecting to an Infinispan Server without authentication. deployments. Default is 'true'. |
boolean |
|
||||||||||||||||||||||||||||||
Sets username used by authentication. |
string |
|||||||||||||||||||||||||||||||
Sets password used by authentication |
string |
|||||||||||||||||||||||||||||||
Sets realm used by authentication |
string |
|
||||||||||||||||||||||||||||||
Sets server name used by authentication |
string |
|
||||||||||||||||||||||||||||||
Sets client subject, necessary for those SASL mechanisms which require it to access client credentials. |
string |
|||||||||||||||||||||||||||||||
Specifies a |
string |
|||||||||||||||||||||||||||||||
Sets SASL mechanism used by authentication. Available values: * |
string |
|
||||||||||||||||||||||||||||||
Specifies the filename of a truststore to use to create the |
string |
|||||||||||||||||||||||||||||||
Specifies the password needed to open the truststore You also need to specify a trustStore. Setting this property implicitly enables SSL/TLS. |
string |
|||||||||||||||||||||||||||||||
Specifies the type of the truststore, such as JKS or JCEKS. Defaults to JKS if trustStore is enabled. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If enabled, Jackson will fail when encountering unknown properties.
You can still override it locally with |
boolean |
|
||||||||||||||||||||||||||||||
If enabled, Jackson will fail when no accessors are found for a type. This is enabled by default to match the default Jackson behavior. |
boolean |
|
||||||||||||||||||||||||||||||
If enabled, Jackson will serialize dates as numeric value(s). |
boolean |
|
||||||||||||||||||||||||||||||
If enabled, Jackson will ignore case during Enum deserialization. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Define which properties of Java Beans are to be included in serialization. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The jacoco data file |
string |
|
||||||||||||||||||||||||||||||
Whether to reuse ( |
boolean |
|
||||||||||||||||||||||||||||||
If Quarkus should generate the Jacoco report |
boolean |
|
||||||||||||||||||||||||||||||
Encoding of the generated reports. |
string |
|
||||||||||||||||||||||||||||||
Name of the root node HTML report pages. |
string |
|||||||||||||||||||||||||||||||
Footer text used in HTML report pages. |
string |
|||||||||||||||||||||||||||||||
Encoding of the source files. |
string |
|
||||||||||||||||||||||||||||||
A list of class files to include in the report. May use wildcard characters (* and ?). When not specified everything will be included.
For instance:
- |
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.
For instance:
- |
list of string |
|||||||||||||||||||||||||||||||
The location of the report files. |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Defines if the Jaeger extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Whether metrics are published in case a metrics extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
The traces endpoint, in case the client should connect directly to the Collector, like http://jaeger-collector:14268/api/traces |
||||||||||||||||||||||||||||||||
Authentication Token to send as "Bearer" to the endpoint |
string |
|||||||||||||||||||||||||||||||
Username to send as part of "Basic" authentication to the endpoint |
string |
|||||||||||||||||||||||||||||||
Password to send as part of "Basic" authentication to the endpoint |
string |
|||||||||||||||||||||||||||||||
The hostname and port for communicating with agent via UDP |
host:port |
|||||||||||||||||||||||||||||||
Whether the reporter should also log the spans |
boolean |
|||||||||||||||||||||||||||||||
The reporter’s maximum queue size |
int |
|||||||||||||||||||||||||||||||
The reporter’s flush interval |
||||||||||||||||||||||||||||||||
The sampler type (const, probabilistic, ratelimiting or remote) |
string |
|||||||||||||||||||||||||||||||
The sampler parameter (number) |
||||||||||||||||||||||||||||||||
The host name and port when using the remote controlled sampler |
host:port |
|||||||||||||||||||||||||||||||
The service name |
string |
|||||||||||||||||||||||||||||||
A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format ${envVarName:default}, where the :default is optional, and identifies a value to be used if the environment variable cannot be found |
string |
|||||||||||||||||||||||||||||||
Comma separated list of formats to use for propagating the trace context. Defaults to the standard Jaeger format. Valid values are jaeger and b3 |
string |
|||||||||||||||||||||||||||||||
The sender factory class name |
string |
|||||||||||||||||||||||||||||||
Whether the trace context should be logged. |
boolean |
|
||||||||||||||||||||||||||||||
Whether the registration of tracer as the global tracer should be disabled. This setting should only be turned on in tests that need to install a mock tracer. |
boolean |
|
||||||||||||||||||||||||||||||
Whether jaeger should run in zipkin compatibility mode |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enables policy enforcement. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
int |
|
||||||||||||||||||||||||||||||
Specifies how policies are enforced. |
|
|
||||||||||||||||||||||||||||||
Defines the limit of entries that should be kept in the cache |
int |
|
||||||||||||||||||||||||||||||
Defines the time in milliseconds when the entry should be expired |
long |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The name of a resource on the server that is to be associated with a given path |
string |
|||||||||||||||||||||||||||||||
A URI relative to the application’s context path that should be protected by the policy enforcer |
string |
|||||||||||||||||||||||||||||||
The name of the HTTP method |
string |
required |
||||||||||||||||||||||||||||||
An array of strings with the scopes associated with the method |
list of string |
required |
||||||||||||||||||||||||||||||
A string referencing the enforcement mode for the scopes associated with a method |
|
|
||||||||||||||||||||||||||||||
Specifies how policies are enforced |
|
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
int |
|
||||||||||||||||||||||||||||||
Specifies how policies are enforced. |
|
|
||||||||||||||||||||||||||||||
The name of a resource on the server that is to be associated with a given path |
string |
|||||||||||||||||||||||||||||||
A URI relative to the application’s context path that should be protected by the policy enforcer |
string |
|||||||||||||||||||||||||||||||
The name of the HTTP method |
string |
required |
||||||||||||||||||||||||||||||
An array of strings with the scopes associated with the method |
list of string |
required |
||||||||||||||||||||||||||||||
A string referencing the enforcement mode for the scopes associated with a method |
|
|
||||||||||||||||||||||||||||||
Specifies how policies are enforced |
|
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
Defines the limit of entries that should be kept in the cache |
int |
|
||||||||||||||||||||||||||||||
Defines the time in milliseconds when the entry should be expired |
long |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The name of the group this component belongs too |
string |
|||||||||||||||||||||||||||||||
The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on … |
string |
|
||||||||||||||||||||||||||||||
The version of the application. |
string |
|
||||||||||||||||||||||||||||||
The namespace the generated resources should belong to. If not value is set, then the 'namespace' field will not be added to the 'metadata' section of the generated manifests. This in turn means that when the manifests are applied to a cluster, the namespace will be resolved from the current Kubernetes context (see https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context for more details). |
string |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Working directory |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed |
string |
|||||||||||||||||||||||||||||||
The type of service that will be generated for the application |
|
|
||||||||||||||||||||||||||||||
Image pull policy |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is |
string |
|
||||||||||||||||||||||||||||||
Define the annotation used to indicate services that should be scraped. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the path to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the port to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the scheme to use for scraping By default, |
string |
|||||||||||||||||||||||||||||||
If set, it will change the name of the container according to the configuration |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
Whether this service is cluster-local. Cluster local services are not exposed to the outside world. More information in this link. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
The scale-to-zero values control whether Knative allows revisions to scale down to zero, or stops at “1”. |
boolean |
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
If set, the secret will mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
If set, the config map will be mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
The SELinux level label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux role label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux type label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux user label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The name of the GMSA credential spec to use. |
string |
|||||||||||||||||||||||||||||||
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
string |
|||||||||||||||||||||||||||||||
The UserName in Windows to run the entrypoint of the container process. |
string |
|||||||||||||||||||||||||||||||
HostProcess determines if a container should be run as a 'Host Process' container. |
boolean |
|||||||||||||||||||||||||||||||
The UID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
The GID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
Indicates that the container must run as a non-root user. |
boolean |
|||||||||||||||||||||||||||||||
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. |
list of long |
|||||||||||||||||||||||||||||||
A special supplemental group that applies to all containers in a pod. |
long |
|||||||||||||||||||||||||||||||
Sysctls hold a list of namespaced sysctls used for the pod. |
string |
|||||||||||||||||||||||||||||||
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always |
|
|||||||||||||||||||||||||||||||
Custom labels to add to all resources |
|
|||||||||||||||||||||||||||||||
Custom annotations to add to all resources |
|
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
The host port. |
int |
|||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
The protocol. |
|
|
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the secret to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the ConfigMap to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
Git repository URL. |
string |
required |
||||||||||||||||||||||||||||||
The directory of the repository to mount. |
string |
|||||||||||||||||||||||||||||||
The commit hash to use. |
string |
|||||||||||||||||||||||||||||||
The name of the claim to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
string |
|
|||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
The secret name. |
string |
required |
||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed |
string |
required |
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
Disk caching mode. |
|
|
||||||||||||||||||||||||||||||
File system type. |
string |
|
||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The ip address |
string |
|||||||||||||||||||||||||||||||
The hostnames to resolve to the ip |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
Tag is optionally used to expose a dedicated url for referencing this target exclusively. |
string |
|||||||||||||||||||||||||||||||
RevisionName of a specific revision to which to send this portion of traffic. |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
long |
|
||||||||||||||||||||||||||||||
The name of the group this component belongs too |
string |
|||||||||||||||||||||||||||||||
The name of the application. This value will be used for naming Kubernetes resources like: - Deployment - Service and so on … |
string |
|
||||||||||||||||||||||||||||||
The version of the application. |
string |
|
||||||||||||||||||||||||||||||
The kind of the deployment resource to use. Supported values are 'Deployment' and 'StatefulSet' defaulting to the first. |
|
|
||||||||||||||||||||||||||||||
The namespace the generated resources should belong to. If not value is set, then the 'namespace' field will not be added to the 'metadata' section of the generated manifests. This in turn means that when the manifests are applied to a cluster, the namespace will be resolved from the current Kubernetes context (see https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context for more details). |
string |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Working directory |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed |
string |
|||||||||||||||||||||||||||||||
The number of desired pods |
int |
|
||||||||||||||||||||||||||||||
The type of service that will be generated for the application |
|
|
||||||||||||||||||||||||||||||
The nodePort to set when serviceType is set to node-port. |
int |
|||||||||||||||||||||||||||||||
Image pull policy |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is |
string |
|
||||||||||||||||||||||||||||||
Define the annotation used to indicate services that should be scraped. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the path to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the port to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the scheme to use for scraping By default, |
string |
|||||||||||||||||||||||||||||||
The target deployment platform. Defaults to kubernetes. Can be kubernetes, openshift, knative, minikube etc., or any combination of the above as comma separated list. |
list of string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
If true, a Kubernetes Ingress will be created |
boolean |
|
||||||||||||||||||||||||||||||
If true, the service will be exposed |
boolean |
|
||||||||||||||||||||||||||||||
The host under which the application is going to be exposed |
string |
|||||||||||||||||||||||||||||||
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster |
boolean |
|
||||||||||||||||||||||||||||||
If set, the secret will mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
If set, the config map will be mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
The SELinux level label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux role label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux type label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux user label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The name of the GMSA credential spec to use. |
string |
|||||||||||||||||||||||||||||||
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
string |
|||||||||||||||||||||||||||||||
The UserName in Windows to run the entrypoint of the container process. |
string |
|||||||||||||||||||||||||||||||
HostProcess determines if a container should be run as a 'Host Process' container. |
boolean |
|||||||||||||||||||||||||||||||
The UID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
The GID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
Indicates that the container must run as a non-root user. |
boolean |
|||||||||||||||||||||||||||||||
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. |
list of long |
|||||||||||||||||||||||||||||||
A special supplemental group that applies to all containers in a pod. |
long |
|||||||||||||||||||||||||||||||
Sysctls hold a list of namespaced sysctls used for the pod. |
string |
|||||||||||||||||||||||||||||||
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always |
|
|||||||||||||||||||||||||||||||
If set, it will change the name of the container according to the configuration |
string |
|||||||||||||||||||||||||||||||
If true, the debug mode in pods will be enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The transport to use. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
It specifies the address at which the debug socket will listen. |
int |
|
||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
Custom labels to add to all resources |
|
|||||||||||||||||||||||||||||||
Custom annotations to add to all resources |
|
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
The host port. |
int |
|||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
The protocol. |
|
|
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the secret to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the ConfigMap to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
Git repository URL. |
string |
required |
||||||||||||||||||||||||||||||
The directory of the repository to mount. |
string |
|||||||||||||||||||||||||||||||
The commit hash to use. |
string |
|||||||||||||||||||||||||||||||
The name of the claim to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
string |
|
|||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed |
string |
required |
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
Disk caching mode. |
|
|
||||||||||||||||||||||||||||||
File system type. |
string |
|
||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The ip address |
string |
|||||||||||||||||||||||||||||||
The hostnames to resolve to the ip |
list of string |
|||||||||||||||||||||||||||||||
Custom annotations to add to exposition (route or ingress) resources |
|
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||||
The kind of the deployment resource to use. Supported values are 'Deployment' and 'DeploymentConfig' defaulting to the latter. |
|
|||||||||||||||||||||||||||||||
The name of the group this component belongs too |
string |
|||||||||||||||||||||||||||||||
The name of the application. This value will be used for naming Kubernetes resources like: 'Deployment', 'Service' and so on… |
string |
|
||||||||||||||||||||||||||||||
The version of the application. |
string |
|
||||||||||||||||||||||||||||||
The namespace the generated resources should belong to. If not value is set, then the 'namespace' field will not be added to the 'metadata' section of the generated manifests. This in turn means that when the manifests are applied to a cluster, the namespace will be resolved from the current Kubernetes context (see https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context for more details). |
string |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Working directory |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed |
string |
|||||||||||||||||||||||||||||||
The number of desired pods |
int |
|
||||||||||||||||||||||||||||||
The type of service that will be generated for the application |
|
|
||||||||||||||||||||||||||||||
The nodePort to set when serviceType is set to nodePort |
int |
|||||||||||||||||||||||||||||||
Image pull policy |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Define the annotation prefix used for scrape values, this value will be used as the base for other annotation name defaults. Altering the base for generated annotations can make it easier to define re-labeling rules and avoid unexpected knock-on effects. The default value is |
string |
|
||||||||||||||||||||||||||||||
Define the annotation used to indicate services that should be scraped. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the path to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the port to scrape. By default, |
string |
|||||||||||||||||||||||||||||||
Define the annotation used to indicate the scheme to use for scraping By default, |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
If set, it will change the name of the container according to the configuration |
string |
|||||||||||||||||||||||||||||||
If true, an Openshift Route will be created |
boolean |
|
||||||||||||||||||||||||||||||
If true, the service will be exposed |
boolean |
|
||||||||||||||||||||||||||||||
The host under which the application is going to be exposed |
string |
|||||||||||||||||||||||||||||||
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and DeploymentConfig |
boolean |
|
||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
If set, the secret will mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
If set, the config amp will be mounted to the application container and its contents will be used for application configuration. |
string |
|||||||||||||||||||||||||||||||
The SELinux level label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux role label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux type label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The SELinux user label that applies to the container. |
string |
|||||||||||||||||||||||||||||||
The name of the GMSA credential spec to use. |
string |
|||||||||||||||||||||||||||||||
GMSACredentialSpec is where the GMSA admission webhook (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the GMSA credential spec named by the GMSACredentialSpecName field. |
string |
|||||||||||||||||||||||||||||||
The UserName in Windows to run the entrypoint of the container process. |
string |
|||||||||||||||||||||||||||||||
HostProcess determines if a container should be run as a 'Host Process' container. |
boolean |
|||||||||||||||||||||||||||||||
The UID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
The GID to run the entrypoint of the container process. |
long |
|||||||||||||||||||||||||||||||
Indicates that the container must run as a non-root user. |
boolean |
|||||||||||||||||||||||||||||||
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. |
list of long |
|||||||||||||||||||||||||||||||
A special supplemental group that applies to all containers in a pod. |
long |
|||||||||||||||||||||||||||||||
Sysctls hold a list of namespaced sysctls used for the pod. |
string |
|||||||||||||||||||||||||||||||
It holds policies that will be used for applying fsGroup to a volume when volume is mounted. Values: OnRootMismatch, Always |
|
|||||||||||||||||||||||||||||||
If true, the debug mode in pods will be enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The transport to use. |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
It specifies the address at which the debug socket will listen. |
int |
|
||||||||||||||||||||||||||||||
Custom labels to add to all resources |
|
|||||||||||||||||||||||||||||||
Custom annotations to add to all resources |
|
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
The host port. |
int |
|||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
The protocol. |
|
|
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the secret to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the ConfigMap to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
Git repository URL. |
string |
required |
||||||||||||||||||||||||||||||
The directory of the repository to mount. |
string |
|||||||||||||||||||||||||||||||
The commit hash to use. |
string |
|||||||||||||||||||||||||||||||
The name of the claim to mount. |
string |
required |
||||||||||||||||||||||||||||||
Default mode. When specifying an octal number, leading zero must be present. |
string |
|
||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
string |
|
|||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The name of the disk to mount. |
string |
required |
||||||||||||||||||||||||||||||
The URI of the vhd blob object OR the resourceID of an Azure managed data disk if Kind is Managed |
string |
required |
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
Disk caching mode. |
|
|
||||||||||||||||||||||||||||||
File system type. |
string |
|
||||||||||||||||||||||||||||||
Whether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
list of string |
||||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The container image. |
string |
|||||||||||||||||||||||||||||||
Working directory. |
string |
|||||||||||||||||||||||||||||||
The commands |
list of string |
|||||||||||||||||||||||||||||||
The arguments |
list of string |
|||||||||||||||||||||||||||||||
The service account. |
string |
|||||||||||||||||||||||||||||||
The host under which the application is going to be exposed. |
string |
|||||||||||||||||||||||||||||||
The port number. Refers to the container port. |
int |
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
The application path (refers to web application path). |
string |
|
||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
int |
||||||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
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) |
string |
|||||||||||||||||||||||||||||||
The command to use for the probe. |
string |
|||||||||||||||||||||||||||||||
The tcp socket to use for the probe (the format is host:port). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait before starting to probe. |
|
|||||||||||||||||||||||||||||||
The period in which the action should be called. |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for each action. |
|
|||||||||||||||||||||||||||||||
The success threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The failure threshold to use. |
int |
|
||||||||||||||||||||||||||||||
The name of the volumeName to mount. |
string |
|||||||||||||||||||||||||||||||
The path to mount. |
string |
|||||||||||||||||||||||||||||||
Path within the volumeName from which the container’s volumeName should be mounted. |
string |
|||||||||||||||||||||||||||||||
boolean |
|
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
CPU Requirements |
string |
|||||||||||||||||||||||||||||||
Memory Requirements |
string |
|||||||||||||||||||||||||||||||
The optional list of Secret names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The optional list of ConfigMap names to load environment variables from. |
list of string |
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
The ip address |
string |
|||||||||||||||||||||||||||||||
The hostnames to resolve to the ip |
list of string |
|||||||||||||||||||||||||||||||
Custom annotations to add to exposition (route or ingress) resources |
|
|||||||||||||||||||||||||||||||
The map associating environment variable names to their associated field references they take their value from. |
|
|||||||||||||||||||||||||||||||
The map associating environment name to its associated value. |
|
|||||||||||||||||||||||||||||||
The optional name of the Secret from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The optional name of the ConfigMap from which a value is to be extracted. Mutually exclusive with |
string |
|||||||||||||||||||||||||||||||
The key identifying the field from which the value is extracted. |
string |
required |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether the client should trust a self-signed certificate if so presented by the API server |
boolean |
|||||||||||||||||||||||||||||||
URL of the Kubernetes API server |
string |
|||||||||||||||||||||||||||||||
Default namespace to use |
string |
|||||||||||||||||||||||||||||||
CA certificate file |
string |
|||||||||||||||||||||||||||||||
CA certificate data |
string |
|||||||||||||||||||||||||||||||
Client certificate file |
string |
|||||||||||||||||||||||||||||||
Client certificate data |
string |
|||||||||||||||||||||||||||||||
Client key file |
string |
|||||||||||||||||||||||||||||||
Client key data |
string |
|||||||||||||||||||||||||||||||
Client key algorithm |
string |
|||||||||||||||||||||||||||||||
Client key passphrase |
string |
|||||||||||||||||||||||||||||||
Kubernetes auth username |
string |
|||||||||||||||||||||||||||||||
Kubernetes auth password |
string |
|||||||||||||||||||||||||||||||
Kubernetes oauth token |
string |
|||||||||||||||||||||||||||||||
Watch reconnect interval |
|
|||||||||||||||||||||||||||||||
Maximum reconnect attempts in case of watch failure By default there is no limit to the number of reconnect attempts |
int |
|
||||||||||||||||||||||||||||||
Maximum amount of time to wait for a connection with the API server to be established |
|
|||||||||||||||||||||||||||||||
Maximum amount of time to wait for a request to the API server to be completed |
|
|||||||||||||||||||||||||||||||
Maximum amount of time in milliseconds to wait for a rollout to be completed |
|
|||||||||||||||||||||||||||||||
HTTP proxy used to access the Kubernetes API server |
string |
|||||||||||||||||||||||||||||||
HTTPS proxy used to access the Kubernetes API server |
string |
|||||||||||||||||||||||||||||||
Proxy username |
string |
|||||||||||||||||||||||||||||||
Proxy password |
string |
|||||||||||||||||||||||||||||||
IP addresses or hosts to exclude from proxying |
list of string |
|||||||||||||||||||||||||||||||
Enable the generation of the RBAC manifests. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether configuration can be read from secrets. If set to |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, the application will attempt to look up the configuration from the API server |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, the application will not start if any of the configured config sources cannot be located |
boolean |
|
||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
Secrets to look for in the namespace that the Kubernetes Client has been configured for. If you use this, you probably want to enable |
list of string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The mountPath to add in the |
string |
|||||||||||||||||||||||||||||||
Determines if binding should be created as files or env vars. Set this value to |
boolean |
|
||||||||||||||||||||||||||||||
Detects the binding data from resources owned by the backing service. |
boolean |
|
||||||||||||||||||||||||||||||
If enabled, Service Bindings will be looked in the file system |
boolean |
|
||||||||||||||||||||||||||||||
The bindings file system root. Specified by the Kubernetes Service ServiceBinding Specification. |
string |
|
||||||||||||||||||||||||||||||
The name of the service binding. If no value is specified the id of the service will be used instead. |
string |
|||||||||||||||||||||||||||||||
The kind of the service. |
string |
|||||||||||||||||||||||||||||||
The apiVersion of the service |
string |
|||||||||||||||||||||||||||||||
The name of the service. When this is empty the key of the service is meant to be used as name. |
string |
|||||||||||||||||||||||||||||||
The namespace of the service. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The liquibase change log file. All included change log files in this file are scanned and add to the projects. |
string |
|
||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of ChangeSet contexts to execute for liquibase. |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of expressions defining labeled ChangeSet to execute for liquibase. |
list of string |
|||||||||||||||||||||||||||||||
The liquibase change log lock table name. Name of table to use for tracking concurrent Liquibase usage. |
string |
|
||||||||||||||||||||||||||||||
The liquibase change log table name. Name of table to use for tracking change history. |
string |
|
||||||||||||||||||||||||||||||
The name of Liquibase’s default catalog. |
string |
|||||||||||||||||||||||||||||||
The name of Liquibase’s default schema. Overwrites the default schema name (returned by the RDBMS) with a different database schema. |
string |
|||||||||||||||||||||||||||||||
The name of the catalog with the liquibase tables. |
string |
|||||||||||||||||||||||||||||||
The name of the schema with the liquibase tables. |
string |
|||||||||||||||||||||||||||||||
The name of the tablespace where the -LOG and -LOCK tables will be created (if they do not exist yet). |
string |
|||||||||||||||||||||||||||||||
The liquibase change log file. All included change log files in this file are scanned and add to the projects. |
string |
|
||||||||||||||||||||||||||||||
Map of parameters that can be used inside Liquibase changeLog files. |
|
|||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
|
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of ChangeSet contexts to execute for liquibase. |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated case-sensitive list of expressions defining labeled ChangeSet to execute for liquibase. |
list of string |
|||||||||||||||||||||||||||||||
Map of parameters that can be used inside Liquibase changeLog files. |
|
|||||||||||||||||||||||||||||||
The liquibase change log lock table name. Name of table to use for tracking concurrent Liquibase usage. |
string |
|
||||||||||||||||||||||||||||||
The liquibase change log table name. Name of table to use for tracking change history. |
string |
|
||||||||||||||||||||||||||||||
The name of Liquibase’s default catalog. |
string |
|||||||||||||||||||||||||||||||
The name of Liquibase’s default schema. Overwrites the default schema name (returned by the RDBMS) with a different database schema. |
string |
|||||||||||||||||||||||||||||||
The name of the catalog with the liquibase tables. |
string |
|||||||||||||||||||||||||||||||
The name of the schema with the liquibase tables. |
string |
|||||||||||||||||||||||||||||||
The name of the tablespace where the -LOG and -LOCK tables will be created (if they do not exist yet). |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The change log file |
string |
|
||||||||||||||||||||||||||||||
The migrate at start flag |
boolean |
|
||||||||||||||||||||||||||||||
The validate on update flag |
boolean |
|
||||||||||||||||||||||||||||||
The clean at start flag |
boolean |
|
||||||||||||||||||||||||||||||
The list of contexts |
list of string |
|||||||||||||||||||||||||||||||
The list of labels |
list of string |
|||||||||||||||||||||||||||||||
The default catalog name |
string |
|||||||||||||||||||||||||||||||
The default schema name |
string |
|||||||||||||||||||||||||||||||
The liquibase tables catalog name |
string |
|||||||||||||||||||||||||||||||
The liquibase tables schema name |
string |
|||||||||||||||||||||||||||||||
The liquibase tables tablespace name |
string |
|||||||||||||||||||||||||||||||
The parameters to be passed to the changelog. Defined as key value pairs. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Determine whether to enable the GELF logging handler |
boolean |
|
||||||||||||||||||||||||||||||
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" |
string |
|
||||||||||||||||||||||||||||||
The port |
int |
|
||||||||||||||||||||||||||||||
GELF version: 1.0 or 1.1 |
string |
|
||||||||||||||||||||||||||||||
Whether to post Stack-Trace to StackTrace field. |
boolean |
|
||||||||||||||||||||||||||||||
Only used when |
int |
|
||||||||||||||||||||||||||||||
Whether to perform Stack-Trace filtering |
boolean |
|
||||||||||||||||||||||||||||||
Java date pattern, see |
string |
|
||||||||||||||||||||||||||||||
The logging-gelf log level. |
|
|||||||||||||||||||||||||||||||
Name of the facility. |
string |
|
||||||||||||||||||||||||||||||
Whether to include all fields from the MDC. |
boolean |
|
||||||||||||||||||||||||||||||
Maximum message size (in bytes). If the message size is exceeded, the appender will submit the message in multiple chunks. |
int |
|
||||||||||||||||||||||||||||||
Include message parameters from the log event |
boolean |
|
||||||||||||||||||||||||||||||
Include source code location |
boolean |
|
||||||||||||||||||||||||||||||
Origin hostname |
string |
|||||||||||||||||||||||||||||||
Bypass hostname resolution. If you didn’t set the |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Additional field value. |
string |
required |
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. |
boolean |
|
||||||||||||||||||||||||||||||
Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read pretty printed output. |
boolean |
|
||||||||||||||||||||||||||||||
The date format to use. The special string "default" indicates that the default format should be used. |
string |
|
||||||||||||||||||||||||||||||
The special end-of-record delimiter to be used. By default, newline is used as delimiter. |
string |
|||||||||||||||||||||||||||||||
The zone ID to use. The special string "default" indicates that the default zone should be used. |
string |
|
||||||||||||||||||||||||||||||
The exception output type to specify. |
|
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Override keys with custom values. Omitting this value indicates that no key overrides will be applied. |
string |
|||||||||||||||||||||||||||||||
Keys to be excluded from the Json output. |
list of string |
|||||||||||||||||||||||||||||||
Additional field value. |
string |
required |
||||||||||||||||||||||||||||||
Additional field type specification. Supported types: string, int, long String is the default if not specified. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. |
boolean |
|
||||||||||||||||||||||||||||||
Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read pretty printed output. |
boolean |
|
||||||||||||||||||||||||||||||
The date format to use. The special string "default" indicates that the default format should be used. |
string |
|
||||||||||||||||||||||||||||||
The special end-of-record delimiter to be used. By default, newline is used as delimiter. |
string |
|||||||||||||||||||||||||||||||
The zone ID to use. The special string "default" indicates that the default zone should be used. |
string |
|
||||||||||||||||||||||||||||||
The exception output type to specify. |
|
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Override keys with custom values. Omitting this value indicates that no key overrides will be applied. |
string |
|||||||||||||||||||||||||||||||
Keys to be excluded from the Json output. |
list of string |
|||||||||||||||||||||||||||||||
Additional field value. |
string |
required |
||||||||||||||||||||||||||||||
Additional field type specification. Supported types: string, int, long String is the default if not specified. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Caches data from attachment’s Stream to a temporary file. It tries to delete it after sending email. |
boolean |
|
||||||||||||||||||||||||||||||
Sets the default |
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. |
boolean |
|||||||||||||||||||||||||||||||
Sets the default bounce email address. A bounced email, or bounce, is an email message that gets rejected by a mail server. |
string |
|||||||||||||||||||||||||||||||
Sets the SMTP host name. |
string |
|
||||||||||||||||||||||||||||||
The SMTP port. The default value depends on the configuration. The port 25 is used as default when |
int |
|||||||||||||||||||||||||||||||
Sets the username to connect to the SMTP server. |
string |
|||||||||||||||||||||||||||||||
Sets the password to connect to the SMTP server. |
string |
|||||||||||||||||||||||||||||||
Enables or disables the TLS/SSL. |
boolean |
|
||||||||||||||||||||||||||||||
Set whether all server certificates should be trusted. This option is only used when |
boolean |
|||||||||||||||||||||||||||||||
Sets the max number of open connections to the mail server. |
int |
|
||||||||||||||||||||||||||||||
Sets the hostname to be used for HELO/EHLO and the Message-ID. |
string |
|||||||||||||||||||||||||||||||
Sets if connection pool is enabled. If the connection pooling is disabled, the max number of sockets is enforced nevertheless. |
boolean |
|
||||||||||||||||||||||||||||||
Disable ESMTP. The RFC-1869 states that clients should always attempt |
boolean |
|
||||||||||||||||||||||||||||||
Sets the TLS security mode for the connection. Either |
string |
|
||||||||||||||||||||||||||||||
Enables DKIM signing. |
boolean |
|
||||||||||||||||||||||||||||||
Configures the PKCS#8 format private key used to sign the email. |
string |
|||||||||||||||||||||||||||||||
Configures the PKCS#8 format private key file path. |
string |
|||||||||||||||||||||||||||||||
Configures the Agent or User Identifier (AUID). |
string |
|||||||||||||||||||||||||||||||
Configures the selector used to query the public key. |
string |
|||||||||||||||||||||||||||||||
Configures the Signing Domain Identifier (SDID). |
string |
|||||||||||||||||||||||||||||||
Configures the canonicalization algorithm for signed headers. |
|
|||||||||||||||||||||||||||||||
Configures the canonicalization algorithm for mail body. |
|
|||||||||||||||||||||||||||||||
Configures the body limit to sign. Must be greater than zero. |
int |
|||||||||||||||||||||||||||||||
Configures to enable or disable signature sign timestamp. |
boolean |
|||||||||||||||||||||||||||||||
Configures the expire time in seconds when the signature sign will be expired. Must be greater than zero. |
long |
|||||||||||||||||||||||||||||||
Configures the signed headers in DKIM, separated by commas. The order in the list matters. |
list of string |
|||||||||||||||||||||||||||||||
Sets the login mode for the connection. Either |
string |
|
||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
Sets the trust store password if any. Note that the password is only used for JKS and PCK#12 trust stores. |
string |
|||||||||||||||||||||||||||||||
Sets the location of the trust store files. If you use JKS or PCK#12, only one path is allowed. If you use PEM files, you can specify multiple paths. The relative paths are relative to the application working directly. |
list of string |
|||||||||||||||||||||||||||||||
Sets the trust store type. By default, it guesses the type from the file name extension. For instance, |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Sets if sending allows recipients errors. If set to true, the mail will be sent to the recipients that the server accepted, if any. |
boolean |
|
||||||||||||||||||||||||||||||
Enables or disables the pipelining capability if the SMTP server supports it. |
boolean |
|
||||||||||||||||||||||||||||||
Sets the connection pool cleaner period. Zero disables expiration checks and connections will remain in the pool until they are closed. |
|
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Sets the workstation used on NTLM authentication. |
string |
|||||||||||||||||||||||||||||||
Sets the domain used on NTLM authentication. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Micrometer metrics support. Micrometer metrics support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Micrometer MeterRegistry discovery. Micrometer MeterRegistry implementations discovered on the classpath will be enabled automatically by default. |
boolean |
|
||||||||||||||||||||||||||||||
Micrometer MeterBinder discovery. Micrometer MeterBinder implementations discovered on the classpath will be enabled automatically by default. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Kafka metrics support.
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 |
boolean |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Eclipse MicroProfile Metrics support. Support for MicroProfile Metrics will be enabled if Micrometer support is enabled and the MicroProfile Metrics dependency is present:
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. |
boolean |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Vert.x metrics support.
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 |
boolean |
|||||||||||||||||||||||||||||||
Support for export to JSON format. Off by default. |
boolean |
|
||||||||||||||||||||||||||||||
The path for the JSON metrics endpoint. The default value is |
string |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
The path for the prometheus metrics endpoint (produces text/plain). The default value is
|
string |
|
||||||||||||||||||||||||||||||
By default, this extension will create a Prometheus MeterRegistry instance. Use this attribute to veto the creation of the default Prometheus MeterRegistry. |
boolean |
|
||||||||||||||||||||||||||||||
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, Patterns specified here will take precedence over those computed values. For example, if |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of regular expressions defining uri paths that should be ignored (not measured). |
list of string |
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Comma-separated list of regular expressions used to specify uri labels in http metrics. Vertx instrumentation will attempt to transform parameterized
resource paths, Patterns specified here will take precedence over those computed values. For example, if |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of regular expressions defining uri paths that should be ignored (not measured). |
list of string |
|||||||||||||||||||||||||||||||
Suppress non-application uris from metrics collection.
This will suppress all metrics for non-application endpoints using
Suppressing non-application uris is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Prometheus registry configuration properties. A property source for configuration of the Prometheus MeterRegistry, see https://micrometer.io/docs/registry/prometheus. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
Whether metrics are published in case a metrics extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
Whether tracing spans of driver commands are sent in case the smallrye-opentracing extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, the default clients will always be created even if there are no injection points that use them |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. |
string |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
Configures the connection string. The format is: |
string |
|||||||||||||||||||||||||||||||
Configures the MongoDB server addressed (one if single mode). The addresses are passed as |
list of string |
|
||||||||||||||||||||||||||||||
Configure the database name. |
string |
|||||||||||||||||||||||||||||||
Configures the application name. |
string |
|||||||||||||||||||||||||||||||
Configures the maximum number of connections in the connection pool. |
int |
|||||||||||||||||||||||||||||||
Configures the minimum number of connections in the connection pool. |
int |
|||||||||||||||||||||||||||||||
Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed. |
||||||||||||||||||||||||||||||||
Maximum lifetime of a pooled connection. A connection that exceeds this limit will be closed. |
||||||||||||||||||||||||||||||||
Configures the time period between runs of the maintenance job. |
||||||||||||||||||||||||||||||||
Configures period of time to wait before running the first maintenance job on the connection pool. |
||||||||||||||||||||||||||||||||
How long a connection can take to be opened before timing out. |
||||||||||||||||||||||||||||||||
How long a socket read can take before timing out. |
||||||||||||||||||||||||||||||||
If connecting with TLS, this option enables insecure TLS connections. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to connect using TLS. |
boolean |
|
||||||||||||||||||||||||||||||
Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set. |
string |
|||||||||||||||||||||||||||||||
How long the driver will wait for server selection to succeed before throwing an exception. |
||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The frequency that the driver will attempt to determine the current state of each server in the cluster. |
||||||||||||||||||||||||||||||||
Configures the read concern. Supported values are: |
string |
|||||||||||||||||||||||||||||||
Configures the read preferences. Supported values are: |
string |
|||||||||||||||||||||||||||||||
The database used during the readiness health checks |
string |
|
||||||||||||||||||||||||||||||
The default DNS resolver used to handle |
boolean |
|
||||||||||||||||||||||||||||||
If |
string |
|||||||||||||||||||||||||||||||
If |
int |
|
||||||||||||||||||||||||||||||
If |
|
|||||||||||||||||||||||||||||||
If |
boolean |
|
||||||||||||||||||||||||||||||
Generic properties that are added to the connection URL. |
|
|||||||||||||||||||||||||||||||
Configures the connection string. The format is: |
string |
|||||||||||||||||||||||||||||||
Configures the MongoDB server addressed (one if single mode). The addresses are passed as |
list of string |
|
||||||||||||||||||||||||||||||
Configure the database name. |
string |
|||||||||||||||||||||||||||||||
Configures the application name. |
string |
|||||||||||||||||||||||||||||||
Configures the maximum number of connections in the connection pool. |
int |
|||||||||||||||||||||||||||||||
Configures the minimum number of connections in the connection pool. |
int |
|||||||||||||||||||||||||||||||
Maximum idle time of a pooled connection. A connection that exceeds this limit will be closed. |
||||||||||||||||||||||||||||||||
Maximum lifetime of a pooled connection. A connection that exceeds this limit will be closed. |
||||||||||||||||||||||||||||||||
Configures the time period between runs of the maintenance job. |
||||||||||||||||||||||||||||||||
Configures period of time to wait before running the first maintenance job on the connection pool. |
||||||||||||||||||||||||||||||||
How long a connection can take to be opened before timing out. |
||||||||||||||||||||||||||||||||
How long a socket read can take before timing out. |
||||||||||||||||||||||||||||||||
If connecting with TLS, this option enables insecure TLS connections. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to connect using TLS. |
boolean |
|
||||||||||||||||||||||||||||||
Implies that the hosts given are a seed list, and the driver will attempt to find all members of the set. |
string |
|||||||||||||||||||||||||||||||
How long the driver will wait for server selection to succeed before throwing an exception. |
||||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
The frequency that the driver will attempt to determine the current state of each server in the cluster. |
||||||||||||||||||||||||||||||||
Configures the read concern. Supported values are: |
string |
|||||||||||||||||||||||||||||||
Configures the read preferences. Supported values are: |
string |
|||||||||||||||||||||||||||||||
The database used during the readiness health checks |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Configures the safety. If set to |
boolean |
|
||||||||||||||||||||||||||||||
Configures the journal writing aspect. If set to |
boolean |
|
||||||||||||||||||||||||||||||
When set, the driver adds |
string |
|||||||||||||||||||||||||||||||
If set to |
boolean |
|
||||||||||||||||||||||||||||||
When set, the driver adds |
||||||||||||||||||||||||||||||||
Configures the safety. If set to |
boolean |
|
||||||||||||||||||||||||||||||
Configures the journal writing aspect. If set to |
boolean |
|
||||||||||||||||||||||||||||||
When set, the driver adds |
string |
|||||||||||||||||||||||||||||||
If set to |
boolean |
|
||||||||||||||||||||||||||||||
When set, the driver adds |
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Configures the username. |
string |
|||||||||||||||||||||||||||||||
Configures the password. |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
Configures the source of the authentication credentials. This is typically the database that 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 |
string |
|||||||||||||||||||||||||||||||
Allows passing authentication mechanism properties. |
|
|||||||||||||||||||||||||||||||
Configures the username. |
string |
|||||||||||||||||||||||||||||||
Configures the password. |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
Configures the source of the authentication credentials. This is typically the database that 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 |
string |
|||||||||||||||||||||||||||||||
Allows passing authentication mechanism properties. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The node name used by the transaction manager |
string |
|
||||||||||||||||||||||||||||||
The default transaction timeout |
|
|||||||||||||||||||||||||||||||
The directory name of location of the transaction logs. If the value is not absolute then the directory is relative to the user.dir system property. |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The value configuring the |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If DevServices has been explicitly enabled or disabled. When DevServices is enabled Quarkus will attempt to automatically configure and start Keycloak when running in Dev or Test mode and when Docker is running. |
boolean |
|
||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. Image with a Quarkus based distribution is used by default. Image with a WildFly based distribution can be selected instead, for example: 'quay.io/keycloak/keycloak:18.0.2-legacy'. Note Keycloak Quarkus and Keycloak WildFly images are initialized differently. By default, Dev Services for Keycloak will assume it is a Keycloak Quarkus image if the image version does not end with a '-legacy' string. Set 'quarkus.keycloak.devservices.keycloak-x-image' to override this check. |
string |
|
||||||||||||||||||||||||||||||
If Keycloak-X image is used. By default, Dev Services for Keycloak will assume a Keycloak-X image is used if the image name contains a 'keycloak-x' string. Set 'quarkus.keycloak.devservices.keycloak-x-image' to override this check which may be necessary if you build custom Keycloak-X or Keycloak images. You do not need to set this property if the default check works. |
boolean |
|||||||||||||||||||||||||||||||
Indicates if the Keycloak 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 for Keycloak starts a new container.
The discovery uses the |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
The class or file system path to a Keycloak realm file which will be used to initialize Keycloak. |
string |
|||||||||||||||||||||||||||||||
The JAVA_OPTS passed to the keycloak JVM |
string |
|||||||||||||||||||||||||||||||
The Keycloak realm name. This property will be used to create the realm if the realm file pointed to by the 'realm-path' property does not exist, default value is 'quarkus' in this case. If the realm file pointed to by the 'realm-path' property exists then it is still recommended to set this property for Dev Services for Keycloak to avoid parsing the realm file in order to determine the realm name. |
string |
|||||||||||||||||||||||||||||||
Indicates if the Keycloak realm has to be created when the realm file pointed to by the 'realm-path' property does not exist. Disable it if you’d like to create a realm using Keycloak Administration Console or Keycloak Admin API from |
boolean |
|
||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The Keycloak users map containing the username and password pairs. If this map is empty then two users, 'alice' and 'bob' with the passwords matching their names will be created. This property will be used to create the Keycloak users if the realm file pointed to by the 'realm-path' property does not exist. |
|
|||||||||||||||||||||||||||||||
The Keycloak user roles. If this map is empty then a user named 'alice' will get 'admin' and 'user' roles and all other users will get a 'user' role. This property will be used to create the Keycloak roles if the realm file pointed to by the 'realm-path' property does not exist. |
|
|||||||||||||||||||||||||||||||
If the OIDC extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Grant type which will be used to acquire a token to test the OIDC 'service' applications |
|
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
Enable the registration of the Default TokenIntrospection and UserInfo Cache implementation bean. Note it only allows to use the default implementation, one needs to configure it in order to activate it, please see |
boolean |
|
||||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, |
string |
|||||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens. |
string |
|||||||||||||||||||||||||||||||
The client-id of the application. Each application has a client-id that is used to identify the application |
string |
|||||||||||||||||||||||||||||||
The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to |
||||||||||||||||||||||||||||||||
The number of times an attempt to re-establish an already available connection will be repeated for. Note this property is different to the |
int |
|
||||||||||||||||||||||||||||||
The amount of time after which the current OIDC connection request will time out. |
|
|||||||||||||||||||||||||||||||
The maximum size of the connection pool used by the WebClient |
int |
|||||||||||||||||||||||||||||||
Client secret which is used for a |
string |
|||||||||||||||||||||||||||||||
The client secret value - it will be ignored if 'secret.key' is set |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a secret key |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key from a key store |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
The private key id/alias |
string |
|||||||||||||||||||||||||||||||
The private key password |
string |
|
||||||||||||||||||||||||||||||
JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. |
string |
|||||||||||||||||||||||||||||||
Key identifier of the signing key added as a JWT 'kid' header |
string |
|||||||||||||||||||||||||||||||
Issuer of the signing key added as a JWT 'iss' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Subject of the signing key added as a JWT 'sub' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Signature algorithm, also used for the |
string |
|||||||||||||||||||||||||||||||
JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time. |
int |
|
||||||||||||||||||||||||||||||
The host (name or IP address) of the Proxy. Note: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the "host" config item must be configured to enable the usage of a Proxy. |
string |
|||||||||||||||||||||||||||||||
The port number of the Proxy. Default value is 80. |
int |
|
||||||||||||||||||||||||||||||
The username, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
The password, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from |
string |
|||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust |
path |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the alias of the trust store certificate. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
A unique tenant identifier. It must be set by |
string |
|||||||||||||||||||||||||||||||
If this tenant configuration is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The application type, which can be one of the following values from enum |
|
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC userinfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and 'authentication.user-info-required' property is enabled. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC 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 will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
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 will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Public key for the local JWT token verification. OIDC server connection will not be created when this property is set. |
string |
|||||||||||||||||||||||||||||||
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 where each segment represents a JSON object name only, 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. |
list of string |
|||||||||||||||||||||||||||||||
Separator for splitting a string which may contain multiple group values. It will only be used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence. |
string |
|||||||||||||||||||||||||||||||
Source of the principal roles. |
|
|||||||||||||||||||||||||||||||
Expected issuer 'iss' claim value. Note this property overrides the |
string |
|||||||||||||||||||||||||||||||
Expected audience 'aud' claim value which may be a string or an array of strings. |
list of string |
|||||||||||||||||||||||||||||||
Expected token type |
string |
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Token age. It allows for the number of seconds to be specified that must not elapse since the |
||||||||||||||||||||||||||||||||
Name of the claim which contains a principal name. By default, the 'upn', 'preferred_username' and |
string |
|||||||||||||||||||||||||||||||
Refresh expired ID tokens. If this property is enabled then a refresh token request will be performed if the ID token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the |
boolean |
|
||||||||||||||||||||||||||||||
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. This property will be ignored if the 'refresh-expired' property is not enabled. |
||||||||||||||||||||||||||||||||
Forced JWK set refresh interval in minutes. |
|
|||||||||||||||||||||||||||||||
Custom HTTP header that contains a bearer token. This option is valid only when the application is of type |
string |
|||||||||||||||||||||||||||||||
Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to 'true' by default for backward-compatibility reasons and will be set to |
boolean |
|
||||||||||||||||||||||||||||||
Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI. |
string |
|
||||||||||||||||||||||||||||||
The relative path of the Back-Channel Logout endpoint at the application. |
string |
|||||||||||||||||||||||||||||||
Authorization code flow response mode |
|
|
||||||||||||||||||||||||||||||
Relative path for calculating a "redirect_uri" query parameter. It has to start from a forward slash and will be appended to the request URI’s host and port. For example, if the current request URI is 'https://localhost:8080/service' then a 'redirect_uri' parameter will be 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 will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to 'true'. |
string |
|||||||||||||||||||||||||||||||
If this property is set to 'true' then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an 'error' and an optional 'error_description' parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be 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' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure. |
string |
|||||||||||||||||||||||||||||||
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. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if |
boolean |
|
||||||||||||||||||||||||||||||
Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy. This property, if enabled, will also affect the logout |
boolean |
|
||||||||||||||||||||||||||||||
List of scopes |
list of string |
|||||||||||||||||||||||||||||||
Add the 'openid' scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error. |
boolean |
|
||||||||||||||||||||||||||||||
If enabled the state, session and post logout cookies will have their 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false. |
boolean |
|
||||||||||||||||||||||||||||||
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'. |
string |
|||||||||||||||||||||||||||||||
Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The |
string |
|
||||||||||||||||||||||||||||||
Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the |
string |
|||||||||||||||||||||||||||||||
Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies. |
string |
|||||||||||||||||||||||||||||||
If this property is set to 'true' then an OIDC UserInfo endpoint will be called. |
boolean |
|
||||||||||||||||||||||||||||||
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 will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value then the expired ID token can be refreshed before the session has expired. This property will be ignored if the |
|
|||||||||||||||||||||||||||||||
If this property is set to 'true' then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single Page Applications since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS. If this property is set to |
boolean |
|
||||||||||||||||||||||||||||||
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 will be generated in such cases. |
boolean |
|
||||||||||||||||||||||||||||||
Requires that a Proof Key for Code Exchange (PKCE) is used. |
boolean |
|
||||||||||||||||||||||||||||||
Secret which will be used to encrypt a Proof Key for Code Exchange (PKCE) code verifier in the code flow state. This secret must be set if PKCE is required but no client secret is set. The length of the secret which will be used to encrypt the code verifier must be 32 characters long. |
string |
|||||||||||||||||||||||||||||||
Default TokenStateManager strategy. |
|
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Requires that the tokens are encrypted before being stored in the cookies. |
boolean |
|
||||||||||||||||||||||||||||||
Secret which will be used to encrypt the tokens. This secret must be set if the token encryption is required but no client secret is set. The length of the secret which will be used to encrypt the tokens must be 32 characters long. |
string |
|||||||||||||||||||||||||||||||
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 then please see |
boolean |
|
||||||||||||||||||||||||||||||
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 then please see |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Well known OpenId Connect provider identifier |
|
|||||||||||||||||||||||||||||||
Maximum number of cache entries. Set it to a positive value if the cache has to be enabled. |
int |
|
||||||||||||||||||||||||||||||
Maximum amount of time a given cache entry is valid for. |
|
|||||||||||||||||||||||||||||||
Clean up timer interval. If this property is set then a timer will check and remove the stale entries periodically. |
||||||||||||||||||||||||||||||||
Grant options |
|
|||||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the logout redirect URI. |
|
|||||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the authentication redirect URI. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, |
string |
|||||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens. |
string |
|||||||||||||||||||||||||||||||
The client-id of the application. Each application has a client-id that is used to identify the application |
string |
|||||||||||||||||||||||||||||||
The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to |
||||||||||||||||||||||||||||||||
The number of times an attempt to re-establish an already available connection will be repeated for. Note this property is different to the |
int |
|
||||||||||||||||||||||||||||||
The amount of time after which the current OIDC connection request will time out. |
|
|||||||||||||||||||||||||||||||
The maximum size of the connection pool used by the WebClient |
int |
|||||||||||||||||||||||||||||||
Client secret which is used for a |
string |
|||||||||||||||||||||||||||||||
The client secret value - it will be ignored if 'secret.key' is set |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a secret key |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key from a key store |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
The private key id/alias |
string |
|||||||||||||||||||||||||||||||
The private key password |
string |
|
||||||||||||||||||||||||||||||
JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. |
string |
|||||||||||||||||||||||||||||||
Key identifier of the signing key added as a JWT 'kid' header |
string |
|||||||||||||||||||||||||||||||
Issuer of the signing key added as a JWT 'iss' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Subject of the signing key added as a JWT 'sub' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Signature algorithm, also used for the |
string |
|||||||||||||||||||||||||||||||
JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time. |
int |
|
||||||||||||||||||||||||||||||
The host (name or IP address) of the Proxy. Note: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the "host" config item must be configured to enable the usage of a Proxy. |
string |
|||||||||||||||||||||||||||||||
The port number of the Proxy. Default value is 80. |
int |
|
||||||||||||||||||||||||||||||
The username, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
The password, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from |
string |
|||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust |
path |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the alias of the trust store certificate. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
A unique tenant identifier. It must be set by |
string |
|||||||||||||||||||||||||||||||
If this tenant configuration is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The application type, which can be one of the following values from enum |
|
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC authorization endpoint which authenticates the users. This property must be set for the 'web-app' applications if OIDC discovery is disabled. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC userinfo endpoint. This property must only be set for the 'web-app' applications if OIDC discovery is disabled and 'authentication.user-info-required' property is enabled. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC RFC7662 introspection endpoint which can introspect both opaque and JWT tokens. This property must be set if OIDC discovery is disabled and 1) the opaque bearer access tokens have to be verified or 2) JWT tokens have to be verified while the cached JWK verification set with no matching JWK is being refreshed. This property will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC 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 will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
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 will be ignored if the discovery is enabled. |
string |
|||||||||||||||||||||||||||||||
Public key for the local JWT token verification. OIDC server connection will not be created when this property is set. |
string |
|||||||||||||||||||||||||||||||
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 where each segment represents a JSON object name only, 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. |
list of string |
|||||||||||||||||||||||||||||||
Separator for splitting a string which may contain multiple group values. It will only be used if the "role-claim-path" property points to one or more custom claims whose values are strings. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence. |
string |
|||||||||||||||||||||||||||||||
Source of the principal roles. |
|
|||||||||||||||||||||||||||||||
Expected issuer 'iss' claim value. Note this property overrides the |
string |
|||||||||||||||||||||||||||||||
Expected audience 'aud' claim value which may be a string or an array of strings. |
list of string |
|||||||||||||||||||||||||||||||
Expected token type |
string |
|||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
Token age. It allows for the number of seconds to be specified that must not elapse since the |
||||||||||||||||||||||||||||||||
Name of the claim which contains a principal name. By default, the 'upn', 'preferred_username' and |
string |
|||||||||||||||||||||||||||||||
Refresh expired ID tokens. If this property is enabled then a refresh token request will be performed if the ID token has expired and, if successful, the local session will be updated with the new set of tokens. Otherwise, the local session will be invalidated and the user redirected to the OpenID Provider to re-authenticate. In this case the user may not be challenged again if the OIDC provider session is still active. For this option be effective the |
boolean |
|
||||||||||||||||||||||||||||||
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. This property will be ignored if the 'refresh-expired' property is not enabled. |
||||||||||||||||||||||||||||||||
Forced JWK set refresh interval in minutes. |
|
|||||||||||||||||||||||||||||||
Custom HTTP header that contains a bearer token. This option is valid only when the application is of type |
string |
|||||||||||||||||||||||||||||||
Allow the remote introspection of JWT tokens when no matching JWK key is available. Note this property is set to 'true' by default for backward-compatibility reasons and will be set to |
boolean |
|
||||||||||||||||||||||||||||||
Allow the remote introspection of the opaque tokens. Set this property to 'false' if only JWT tokens are expected. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Name of the post logout URI parameter which will be added as a query parameter to the logout redirect URI. |
string |
|
||||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the logout redirect URI. |
|
|||||||||||||||||||||||||||||||
The relative path of the Back-Channel Logout endpoint at the application. |
string |
|||||||||||||||||||||||||||||||
Authorization code flow response mode |
|
|
||||||||||||||||||||||||||||||
Relative path for calculating a "redirect_uri" query parameter. It has to start from a forward slash and will be appended to the request URI’s host and port. For example, if the current request URI is 'https://localhost:8080/service' then a 'redirect_uri' parameter will be 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 will be restored after the user has authenticated if 'restorePathAfterRedirect' is set to 'true'. |
string |
|||||||||||||||||||||||||||||||
If this property is set to 'true' then the original request URI which was used before the authentication will be restored after the user has been redirected back to the application. Note if |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path to the public endpoint which will process the error response from the OIDC authorization endpoint. If the user authentication has failed then the OIDC provider will return an 'error' and an optional 'error_description' parameters, instead of the expected authorization 'code'. If this property is set then the user will be redirected to the endpoint which can return a user-friendly error description page. It has to start from a forward slash and will be 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' then a redirect will be made to 'https://localhost:8080/error?error=invalid_scope'. If this property is not set then HTTP 401 status will be returned in case of the user authentication failure. |
string |
|||||||||||||||||||||||||||||||
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. Access token is not verified by default since it is meant to be propagated to the downstream services. The verification of the access token should be enabled if it is injected as a JWT token. Access tokens obtained as part of the code flow will always be verified if |
boolean |
|
||||||||||||||||||||||||||||||
Force 'https' as the 'redirect_uri' parameter scheme when running behind an SSL terminating reverse proxy. This property, if enabled, will also affect the logout |
boolean |
|
||||||||||||||||||||||||||||||
List of scopes |
list of string |
|||||||||||||||||||||||||||||||
Add the 'openid' scope automatically to the list of scopes. This is required for OpenId Connect providers but will not work for OAuth2 providers such as Twitter OAuth2 which does not accept that scope and throws an error. |
boolean |
|
||||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the authentication redirect URI. |
|
|||||||||||||||||||||||||||||||
If enabled the state, session and post logout cookies will have their 'secure' parameter set to 'true' when HTTP is used. It may be necessary when running behind an SSL terminating reverse proxy. The cookies will always be secure if HTTPS is used even if this property is set to false. |
boolean |
|
||||||||||||||||||||||||||||||
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'. |
string |
|||||||||||||||||||||||||||||||
Cookie path parameter value which, if set, will be used to set a path parameter for the session, state and post logout cookies. The |
string |
|
||||||||||||||||||||||||||||||
Cookie path header parameter value which, if set, identifies the incoming HTTP header whose value will be used to set a path parameter for the session, state and post logout cookies. If the header is missing then the |
string |
|||||||||||||||||||||||||||||||
Cookie domain parameter value which, if set, will be used for the session, state and post logout cookies. |
string |
|||||||||||||||||||||||||||||||
If this property is set to 'true' then an OIDC UserInfo endpoint will be called. |
boolean |
|
||||||||||||||||||||||||||||||
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 will be redirected to the OIDC provider to re-authenticate once the session has expired. If this property is set to a non-zero value then the expired ID token can be refreshed before the session has expired. This property will be ignored if the |
|
|||||||||||||||||||||||||||||||
If this property is set to 'true' then a normal 302 redirect response will be returned if the request was initiated via JavaScript API such as XMLHttpRequest or Fetch and the current user needs to be (re)authenticated which may not be desirable for Single Page Applications since it automatically following the redirect may not work given that OIDC authorization endpoints typically do not support CORS. If this property is set to |
boolean |
|
||||||||||||||||||||||||||||||
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 will be generated in such cases. |
boolean |
|
||||||||||||||||||||||||||||||
Requires that a Proof Key for Code Exchange (PKCE) is used. |
boolean |
|
||||||||||||||||||||||||||||||
Secret which will be used to encrypt a Proof Key for Code Exchange (PKCE) code verifier in the code flow state. This secret must be set if PKCE is required but no client secret is set. The length of the secret which will be used to encrypt the code verifier must be 32 characters long. |
string |
|||||||||||||||||||||||||||||||
Default TokenStateManager strategy. |
|
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Requires that the tokens are encrypted before being stored in the cookies. |
boolean |
|
||||||||||||||||||||||||||||||
Secret which will be used to encrypt the tokens. This secret must be set if the token encryption is required but no client secret is set. The length of the secret which will be used to encrypt the tokens must be 32 characters long. |
string |
|||||||||||||||||||||||||||||||
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 then please see |
boolean |
|
||||||||||||||||||||||||||||||
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 then please see |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Well known OpenId Connect provider identifier |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If the OIDC client extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, |
string |
|||||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens. |
string |
|||||||||||||||||||||||||||||||
The client-id of the application. Each application has a client-id that is used to identify the application |
string |
|||||||||||||||||||||||||||||||
The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to |
||||||||||||||||||||||||||||||||
The number of times an attempt to re-establish an already available connection will be repeated for. Note this property is different to the |
int |
|
||||||||||||||||||||||||||||||
The amount of time after which the current OIDC connection request will time out. |
|
|||||||||||||||||||||||||||||||
The maximum size of the connection pool used by the WebClient |
int |
|||||||||||||||||||||||||||||||
Client secret which is used for a |
string |
|||||||||||||||||||||||||||||||
The client secret value - it will be ignored if 'secret.key' is set |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a secret key |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key from a key store |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
The private key id/alias |
string |
|||||||||||||||||||||||||||||||
The private key password |
string |
|
||||||||||||||||||||||||||||||
JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. |
string |
|||||||||||||||||||||||||||||||
Key identifier of the signing key added as a JWT 'kid' header |
string |
|||||||||||||||||||||||||||||||
Issuer of the signing key added as a JWT 'iss' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Subject of the signing key added as a JWT 'sub' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Signature algorithm, also used for the |
string |
|||||||||||||||||||||||||||||||
JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time. |
int |
|
||||||||||||||||||||||||||||||
The host (name or IP address) of the Proxy. Note: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the "host" config item must be configured to enable the usage of a Proxy. |
string |
|||||||||||||||||||||||||||||||
The port number of the Proxy. Default value is 80. |
int |
|
||||||||||||||||||||||||||||||
The username, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
The password, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from |
string |
|||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust |
path |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the alias of the trust store certificate. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. |
string |
|||||||||||||||||||||||||||||||
If this client configuration is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
List of access token scopes |
list of string |
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Grant type |
|
|
||||||||||||||||||||||||||||||
Access token property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Refresh token property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Access token expiry property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Refresh token expiry property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Grant options |
|
|||||||||||||||||||||||||||||||
Custom HTTP headers which have to be sent to the token endpoint |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, |
string |
|||||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the OIDC endpoint URLs must be configured individually. |
boolean |
|
||||||||||||||||||||||||||||||
Relative path or absolute URL of the OIDC token endpoint which issues access and refresh tokens. |
string |
|||||||||||||||||||||||||||||||
The client-id of the application. Each application has a client-id that is used to identify the application |
string |
|||||||||||||||||||||||||||||||
The maximum amount of time connecting to the currently unavailable OIDC server will be attempted for. The number of times the connection request will be repeated is calculated by dividing the value of this property by 2. For example, setting it to |
||||||||||||||||||||||||||||||||
The number of times an attempt to re-establish an already available connection will be repeated for. Note this property is different to the |
int |
|
||||||||||||||||||||||||||||||
The amount of time after which the current OIDC connection request will time out. |
|
|||||||||||||||||||||||||||||||
The maximum size of the connection pool used by the WebClient |
int |
|||||||||||||||||||||||||||||||
Client secret which is used for a |
string |
|||||||||||||||||||||||||||||||
The client secret value - it will be ignored if 'secret.key' is set |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a secret key |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider name which should only be set if more than one CredentialsProvider is registered |
string |
|||||||||||||||||||||||||||||||
The CredentialsProvider client secret key |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use the |
string |
|||||||||||||||||||||||||||||||
If provided, indicates that JWT is signed using a private key from a key store |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
The private key id/alias |
string |
|||||||||||||||||||||||||||||||
The private key password |
string |
|
||||||||||||||||||||||||||||||
JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider’s token endpoint. |
string |
|||||||||||||||||||||||||||||||
Key identifier of the signing key added as a JWT 'kid' header |
string |
|||||||||||||||||||||||||||||||
Issuer of the signing key added as a JWT 'iss' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Subject of the signing key added as a JWT 'sub' claim (default: client id) |
string |
|||||||||||||||||||||||||||||||
Signature algorithm, also used for the |
string |
|||||||||||||||||||||||||||||||
JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time. |
int |
|
||||||||||||||||||||||||||||||
The host (name or IP address) of the Proxy. Note: If OIDC adapter needs to use a Proxy to talk with OIDC server (Provider), then at least the "host" config item must be configured to enable the usage of a Proxy. |
string |
|||||||||||||||||||||||||||||||
The port number of the Proxy. Default value is 80. |
int |
|
||||||||||||||||||||||||||||||
The username, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
The password, if Proxy needs authentication. |
string |
|||||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify a provider of the key store file. If not given, the provider is automatically detected based on the key store file type. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
An optional parameter to select a specific key in the key store. When SNI is disabled, if the key store contains multiple keys and no alias is specified, the behavior is undefined. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to define the password for the key, in case it’s different from |
string |
|||||||||||||||||||||||||||||||
An optional trust store which holds the certificate information of the certificates to trust |
path |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the alias of the trust store certificate. |
string |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
A unique OIDC client identifier. It must be set when OIDC clients are created dynamically and is optional in all other cases. |
string |
|||||||||||||||||||||||||||||||
If this client configuration is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
List of access token scopes |
list of string |
|||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Grant type |
|
|
||||||||||||||||||||||||||||||
Access token property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Refresh token property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Access token expiry property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Refresh token expiry property name in a token grant response |
string |
|
||||||||||||||||||||||||||||||
Grant options |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Custom HTTP headers which have to be sent to the token endpoint |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Name of the configured OidcClient. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Name of the configured OidcClient. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If the OIDC Token Propagation is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Exchange the current token with OpenId Connect Provider for a new token before propagating it. Note this property is injected into AccessTokenRequestFilter. |
boolean |
|
||||||||||||||||||||||||||||||
Name of the configured OidcClient. Note this property is injected into AccessTokenRequestFilter and is only used if the |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If the OIDC Token Reactive Propagation is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
OpenTelemetry support. OpenTelemetry support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma separated list of OpenTelemetry propagators which must be supported.
Valid values are |
list of string |
|
||||||||||||||||||||||||||||||
Support for tracing with OpenTelemetry. Support for tracing will be enabled if OpenTelemetry support is enabled and either this value is true, or this value is unset. |
boolean |
|||||||||||||||||||||||||||||||
A comma separated list of name=value resource attributes that represents the entity producing telemetry (eg. |
list of string |
|||||||||||||||||||||||||||||||
The sampler to use for tracing.
Valid values are |
string |
|
||||||||||||||||||||||||||||||
double |
||||||||||||||||||||||||||||||||
If the sampler to use for tracing is parent based.
Valid values are |
boolean |
|
||||||||||||||||||||||||||||||
Suppress non-application uris from trace collection. This will suppress tracing of |
boolean |
|
||||||||||||||||||||||||||||||
Include static resources from trace collection.
Providing a custom |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Jaeger SpanExporter support. Jaeger SpanExporter support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
The Jaeger endpoint to connect to. The endpoint must start with either http:// or https://. |
string |
|||||||||||||||||||||||||||||||
The maximum amount of time to wait for the collector to process exported spans before an exception is thrown. A value of |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
OTLP SpanExporter support. OTLP SpanExporter support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
The OTLP endpoint to connect to. The endpoint must start with either http:// or https://. |
string |
|||||||||||||||||||||||||||||||
Key-value pairs to be used as headers associated with gRPC requests. The format is similar to the |
list of string |
|||||||||||||||||||||||||||||||
The maximum amount of time to wait for the collector to process exported spans before an exception is thrown. A value of |
|
|||||||||||||||||||||||||||||||
Compression method to be used by exporter to compress the payload. See Configuration Options for the supported compression methods. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Set this to false to use the |
boolean |
|
||||||||||||||||||||||||||||||
Name of bean annotated with |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Set this to |
boolean |
|
||||||||||||||||||||||||||||||
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. |
list of 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 |
|
|||||||||||||||||||||||||||||||
Profile that will be active when Quarkus launches Default value is 'prod' |
string |
|||||||||||||||||||||||||||||||
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. |
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 |
list of URI |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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: |
string |
|||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
The header to use for UI Screen (Swagger UI, GraphQL UI etc). |
string |
|
||||||||||||||||||||||||||||||
The path of the banner (path relative to root of classpath) which could be provided by user |
string |
|
||||||||||||||||||||||||||||||
Whether the banner will be displayed |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to throw an error, warn or silently ignore misaligned platform BOM imports |
|
|
||||||||||||||||||||||||||||||
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. WARNING: This config property can only be set in application.properties |
list of string |
|||||||||||||||||||||||||||||||
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. WARNING: This config property can only be set in application.properties |
string |
|||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||||
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 |
|
|
||||||||||||||||||||||||||||||
If test results and status should be displayed in the console. If this is false results can still be viewed in the dev console. |
boolean |
|
||||||||||||||||||||||||||||||
Disables the ability to enter input on the console. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
If set to true, writes a list of all reflective classes to META-INF |
boolean |
|
||||||||||||||||||||||||||||||
If set to a directory, all generated classes will be written into that directory |
string |
|||||||||||||||||||||||||||||||
Global flag that can be used to disable all Dev Services. If this is set to false then Dev Services will not be used. |
boolean |
|
||||||||||||||||||||||||||||||
The timeout for starting a container |
||||||||||||||||||||||||||||||||
The Ide to use to open files from the DevUI. |
|
|
||||||||||||||||||||||||||||||
Paths of library to load. |
list of string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
The names of additional resource files to watch for changes, triggering a reload on change. Directories are not supported. |
list of string |
|||||||||||||||||||||||||||||||
Password used to use to connect to the remote dev-mode application |
string |
|||||||||||||||||||||||||||||||
URL used to use to connect to the remote dev-mode application |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait for a remote dev connect or reconnect |
|
|||||||||||||||||||||||||||||||
The amount of time to wait between attempts when connecting to the server side of remote dev |
|
|||||||||||||||||||||||||||||||
The maximum number of attempts when connecting to the server side of remote dev |
int |
|
||||||||||||||||||||||||||||||
Whether logging metrics are published in case a metrics extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
The default minimum log level. |
|
|||||||||||||||||||||||||||||||
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:
In addition, it also supports the standard JDK log levels. |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated, additional arguments to pass to the build process. If an argument includes the |
list of string |
|||||||||||||||||||||||||||||||
If the HTTP url handler should be enabled, allowing you to do URL.openConnection() for HTTP URLs |
boolean |
|
||||||||||||||||||||||||||||||
If the HTTPS url handler should be enabled, allowing you to do URL.openConnection() for HTTPS URLs |
boolean |
|
||||||||||||||||||||||||||||||
If |
boolean |
|
||||||||||||||||||||||||||||||
The default value for java.awt.headless JVM option. Switching this option affects linking of awt libraries. |
boolean |
|
||||||||||||||||||||||||||||||
Defines the file encoding as in |
string |
|
||||||||||||||||||||||||||||||
If all character sets should be added to the native image. This increases image size |
boolean |
|
||||||||||||||||||||||||||||||
The location of the Graal distribution |
string |
|
||||||||||||||||||||||||||||||
The location of the JDK |
|
|||||||||||||||||||||||||||||||
The maximum Java heap to be used during the native image generation |
string |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
If the debug port should be published when building with docker and debug-build-process is true |
boolean |
|
||||||||||||||||||||||||||||||
If isolates should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
If all META-INF/services entries should be automatically registered |
boolean |
|
||||||||||||||||||||||||||||||
If the bytecode of all proxies should be dumped for inspection |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
If this build is done using a remote docker daemon. |
boolean |
|
||||||||||||||||||||||||||||||
The docker image to use to do the image build. It can be one of |
string |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Options to pass to the container runtime |
list of string |
|||||||||||||||||||||||||||||||
If the resulting image should allow VM introspection |
boolean |
|
||||||||||||||||||||||||||||||
If full stack traces are enabled in the resulting image |
boolean |
|
||||||||||||||||||||||||||||||
If the reports on call paths and included packages/classes/methods should be generated |
boolean |
|
||||||||||||||||||||||||||||||
If exceptions should be reported with a full stack trace |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
A comma separated list of globs to match resource paths that should be added to the native image.
Use slash ( |
list of string |
|||||||||||||||||||||||||||||||
A comma separated list of globs to match resource paths that should not be added to the native image.
Use slash ( |
list of string |
|||||||||||||||||||||||||||||||
If debug is enabled and debug symbols are generated. The symbols will be generated in a separate .debug file. |
boolean |
|
||||||||||||||||||||||||||||||
Generate the report files for GraalVM Dashboard. |
boolean |
|
||||||||||||||||||||||||||||||
The compression level in [1, 10]. 10 means best Higher compression level requires more time to compress the executable. |
int |
|||||||||||||||||||||||||||||||
Allows passing extra arguments to the UPX command line (like --brute). The arguments are comma-separated. The exhaustive list of parameters can be found in https://github.com/upx/upx/blob/devel/doc/upx.pod. |
list of string |
|||||||||||||||||||||||||||||||
The requested output type. The default built in types are 'jar' (which will use 'fast-jar'), 'legacy-jar' for the pre-1.12 default jar packaging, 'uber-jar', 'native' and 'native-sources'. |
string |
|
||||||||||||||||||||||||||||||
If the Implementation information should be included in the runner jar’s MANIFEST.MF. |
boolean |
|
||||||||||||||||||||||||||||||
The entry point of the application. This can either be a fully qualified name of a standard Java class with a main method, or |
string |
|||||||||||||||||||||||||||||||
Files that should not be copied to the output artifact |
list of string |
|||||||||||||||||||||||||||||||
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.
If the type is missing, the artifact is assumed to be of type |
list of string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
The suffix that is applied to the runner jar and native images |
string |
|
||||||||||||||||||||||||||||||
The output folder in which to place the output, this is resolved relative to the build systems target directory. |
string |
|||||||||||||||||||||||||||||||
The name of the final artifact |
string |
|||||||||||||||||||||||||||||||
Whether to automate the creation of AppCDS. This has no effect when a native binary is needed and will be ignored in that case. 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. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
Whether creation of the AppCDS archive should run in a container if available.
Normally, if either a suitable container image to create the AppCDS archive inside of can be determined automatically or if one is explicitly set using the |
boolean |
|
||||||||||||||||||||||||||||||
This is an advanced option that only takes effect for the mutable-jar format. 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. |
string |
|||||||||||||||||||||||||||||||
This option only applies when using fast-jar or mutable-jar. 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. |
boolean |
|
||||||||||||||||||||||||||||||
An advanced option that will decompile generated and transformed bytecode into the 'decompiled' directory. This is only taken into account when fast-jar is used. |
boolean |
|
||||||||||||||||||||||||||||||
The version of Quiltflower to use |
string |
|
||||||||||||||||||||||||||||||
The directory into which to save the fernflower tool if it doesn’t exist |
string |
|
||||||||||||||||||||||||||||||
If set to |
boolean |
|
||||||||||||||||||||||||||||||
Custom manifest attributes to be added to the main section of the MANIFEST.MF file. An example of the user defined property: quarkus.package.manifest.attributes."Entry-key1"=Value1 quarkus.package.manifest.attributes."Entry-key2"=Value2 |
|
|||||||||||||||||||||||||||||||
Custom manifest sections to be added to the MANIFEST.MF file. An example of the user defined property: quarkus.package.manifest.manifest-sections."Section-Name"."Entry-Key1"=Value1 quarkus.package.manifest.manifest-sections."Section-Name"."Entry-Key2"=Value2 |
|
|||||||||||||||||||||||||||||||
groupId of the platform to use |
string |
|
||||||||||||||||||||||||||||||
artifactId of the platform to use |
string |
|
||||||||||||||||||||||||||||||
version of the platform to use |
string |
|
||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
Enable native SSL support. |
boolean |
|||||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||||
If output from the running tests should be displayed in the console. |
boolean |
|
||||||||||||||||||||||||||||||
Tags that should be included for continuous testing. |
list of string |
|||||||||||||||||||||||||||||||
Tags that should be excluded by default with continuous testing. This is ignored if include-tags has been set. Defaults to 'slow' |
list of string |
|
||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
Test engine ids that should be included for continuous testing. |
list of string |
|||||||||||||||||||||||||||||||
Test engine ids that should be excluded by default with continuous testing. This is ignored if include-engines has been set. |
list of string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
The profile to use when testing the native image |
string |
|
||||||||||||||||||||||||||||||
The profile (dev, test or prod) to use when testing using @QuarkusTest |
string |
|
||||||||||||||||||||||||||||||
The tags this profile is associated with. When the |
list of string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Additional launch parameters to be used when Quarkus launches the produced artifact for |
list of string |
|||||||||||||||||||||||||||||||
Used in |
|
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
The type of test to run, this can be either: quarkus-test: Only runs |
|
|
||||||||||||||||||||||||||||||
If a class matches this pattern then it will be cloned into the Quarkus ClassLoader even if it is in a parent first artifact. This is important for collections which can contain objects from the Quarkus ClassLoader, but for most parent first classes it will just cause problems. |
string |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Modules that should be included for continuous testing. This is a regular expression and is matched against the module groupId:artifactId. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Set additional ports to be exposed when @QuarkusIntegration needs to launch the application in a container. |
|
|||||||||||||||||||||||||||||||
The core thread pool size. This number of threads will always be kept alive. |
int |
|
||||||||||||||||||||||||||||||
Prefill core thread pool. The core thread pool will be initialised with the core number of threads at startup |
boolean |
|
||||||||||||||||||||||||||||||
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. |
int |
|||||||||||||||||||||||||||||||
The queue size. For most applications this should be unbounded |
int |
|||||||||||||||||||||||||||||||
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 |
float |
|
||||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
The amount of time a thread will stay alive with no work. |
|
|||||||||||||||||||||||||||||||
Enable trusting all certificates. Disable by default. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maven groupId of the artifact. |
string |
required |
||||||||||||||||||||||||||||||
The maven artifactId of the artifact. |
string |
required |
||||||||||||||||||||||||||||||
The maven classifier of the artifact. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The minimum log level for this category. By default, all categories are configured with |
InheritableLevel |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If console logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
If console logging should go to |
boolean |
|
||||||||||||||||||||||||||||||
The log format. Note that this value will be ignored if an extension is present that takes control of console formatting (e.g. an XML or JSON-format extension). |
string |
|
||||||||||||||||||||||||||||||
The console log level. |
|
|||||||||||||||||||||||||||||||
Specify how much the colors should be darkened. Note that this value will be ignored if an extension is present that takes control of console formatting (e.g. an XML or JSON-format extension). |
int |
|
||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If file logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
The log format |
string |
|
||||||||||||||||||||||||||||||
The level of logs to be written into the file. |
|
|||||||||||||||||||||||||||||||
The name of the file in which logs will be written. |
|
|||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
The maximum file size of the log file after which a rotation is executed. |
|
|||||||||||||||||||||||||||||||
The maximum number of backups to keep. |
int |
|
||||||||||||||||||||||||||||||
File handler rotation file suffix. When used, the file will be rotated based on its suffix. Example fileSuffix: .yyyy-MM-dd |
string |
|||||||||||||||||||||||||||||||
Indicates whether to rotate log files on server initialization.
You need to either set a |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If syslog logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
The IP address and port of the syslog server |
host:port |
|
||||||||||||||||||||||||||||||
The app name used when formatting the message in RFC5424 format |
string |
|||||||||||||||||||||||||||||||
The name of the host the messages are being sent from |
string |
|||||||||||||||||||||||||||||||
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 |
|
|
||||||||||||||||||||||||||||||
Set the |
|
|
||||||||||||||||||||||||||||||
Sets the protocol used to connect to the syslog server |
|
|
||||||||||||||||||||||||||||||
Set to |
boolean |
|
||||||||||||||||||||||||||||||
Set to |
boolean |
|
||||||||||||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a |
boolean |
|
||||||||||||||||||||||||||||||
The log message format |
string |
|
||||||||||||||||||||||||||||||
The log level specifying, which message levels will be logged by syslog logger |
|
|||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The log level for this category. Note that to get log levels below |
InheritableLevel |
|
||||||||||||||||||||||||||||||
The names of the handlers to link to this category. |
list of string |
|||||||||||||||||||||||||||||||
Specify whether this logger should send its output to its parent Logger |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If console logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
If console logging should go to |
boolean |
|
||||||||||||||||||||||||||||||
The log format. Note that this value will be ignored if an extension is present that takes control of console formatting (e.g. an XML or JSON-format extension). |
string |
|
||||||||||||||||||||||||||||||
The console log level. |
|
|||||||||||||||||||||||||||||||
Specify how much the colors should be darkened. Note that this value will be ignored if an extension is present that takes control of console formatting (e.g. an XML or JSON-format extension). |
int |
|
||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If file logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
The log format |
string |
|
||||||||||||||||||||||||||||||
The level of logs to be written into the file. |
|
|||||||||||||||||||||||||||||||
The name of the file in which logs will be written. |
|
|||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
The maximum file size of the log file after which a rotation is executed. |
|
|||||||||||||||||||||||||||||||
The maximum number of backups to keep. |
int |
|
||||||||||||||||||||||||||||||
File handler rotation file suffix. When used, the file will be rotated based on its suffix. Example fileSuffix: .yyyy-MM-dd |
string |
|||||||||||||||||||||||||||||||
Indicates whether to rotate log files on server initialization.
You need to either set a |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If syslog logging should be enabled |
boolean |
|
||||||||||||||||||||||||||||||
The IP address and port of the syslog server |
host:port |
|
||||||||||||||||||||||||||||||
The app name used when formatting the message in RFC5424 format |
string |
|||||||||||||||||||||||||||||||
The name of the host the messages are being sent from |
string |
|||||||||||||||||||||||||||||||
Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 |
|
|
||||||||||||||||||||||||||||||
Set the |
|
|
||||||||||||||||||||||||||||||
Sets the protocol used to connect to the syslog server |
|
|
||||||||||||||||||||||||||||||
Set to |
boolean |
|
||||||||||||||||||||||||||||||
Set to |
boolean |
|
||||||||||||||||||||||||||||||
Enables or disables blocking when attempting to reconnect a |
boolean |
|
||||||||||||||||||||||||||||||
The log message format |
string |
|
||||||||||||||||||||||||||||||
The log level specifying, which message levels will be logged by syslog logger |
|
|||||||||||||||||||||||||||||||
Indicates whether to log asynchronously |
boolean |
|
||||||||||||||||||||||||||||||
The queue length to use before flushing writing |
int |
|
||||||||||||||||||||||||||||||
Determine whether to block the publisher (rather than drop the message) when the queue is full |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The message starts to match |
list of string |
|
||||||||||||||||||||||||||||||
The new log level for the filtered message, defaults to DEBUG |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If enabled, will try to read the configuration from a Spring Cloud Config Server |
boolean |
|
||||||||||||||||||||||||||||||
If set to true, the application will not stand up if it cannot obtain configuration from the Config Server |
boolean |
|
||||||||||||||||||||||||||||||
The Base URI where the Spring Cloud Config Server is available |
string |
|||||||||||||||||||||||||||||||
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). |
string |
|||||||||||||||||||||||||||||||
The amount of time to wait when initially establishing a connection before giving up and timing out.
Specify |
|
|||||||||||||||||||||||||||||||
The amount of time to wait for a read on a socket before an exception is thrown.
Specify |
|
|||||||||||||||||||||||||||||||
The username to be used if the Config Server has BASIC Auth enabled |
string |
|||||||||||||||||||||||||||||||
The password to be used if the Config Server has BASIC Auth enabled |
string |
|||||||||||||||||||||||||||||||
TrustStore to be used containing the SSL certificate used by the Config server Can be either a classpath resource or a file system path |
path |
|||||||||||||||||||||||||||||||
Password of TrustStore to be used containing the SSL certificate used by the Config server |
string |
|||||||||||||||||||||||||||||||
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 |
path |
|||||||||||||||||||||||||||||||
Password of KeyStore to be used containing the SSL certificate for authentication with the Config server |
string |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
When using HTTPS and no keyStore has been specified, whether to trust all certificates |
boolean |
|
||||||||||||||||||||||||||||||
Custom headers to pass the Spring Cloud Config Server when performing the HTTP request |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Enable cluster mode or not. If enabled make sure to set the appropriate cluster properties. |
boolean |
|
||||||||||||||||||||||||||||||
The frequency (in milliseconds) at which the scheduler instance checks-in with other instances of the cluster. |
long |
|
||||||||||||||||||||||||||||||
The type of store to use.
When using |
|
|
||||||||||||||||||||||||||||||
The name of the datasource to use.
Optionally needed when using the |
string |
|||||||||||||||||||||||||||||||
The prefix for quartz job store tables.
Ignored if using a |
string |
|
||||||||||||||||||||||||||||||
The SQL string that selects a row in the "LOCKS" table and places a lock on the row.
If not set, the default value of Quartz applies, for which the "{0}" is replaced during run-time with the |
string |
|||||||||||||||||||||||||||||||
The name of the Quartz instance. |
string |
|
||||||||||||||||||||||||||||||
The size of scheduler thread pool. This will initialize the number of worker threads in the pool. |
int |
|
||||||||||||||||||||||||||||||
Thread priority of worker threads in the pool. |
int |
|
||||||||||||||||||||||||||||||
Defines how late the schedulers should be to be considered misfired. |
|
|||||||||||||||||||||||||||||||
Scheduler can be started in different modes: normal, forced or halted. By default, the scheduler is not started unless a |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||||
The properties passed to the class. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||||
The properties passed to the class. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||||
The properties passed to the class. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The quartz misfire policy for this job. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The list of suffixes used when attempting to locate a template file. By default, |
list of string |
|
||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
This regular expression is used to exclude template files from the |
|
|||||||||||||||||||||||||||||||
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:
- |
string |
|
||||||||||||||||||||||||||||||
The list of content types for which the |
list of string |
|
||||||||||||||||||||||||||||||
The default charset of the templates files. |
|
|||||||||||||||||||||||||||||||
The strategy used when a standalone expression evaluates to a "not found" value at runtime and the |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
If set to |
boolean |
|
||||||||||||||||||||||||||||||
The global rendering timeout in milliseconds. It is used if no |
long |
|
||||||||||||||||||||||||||||||
If set to |
boolean |
|
||||||||||||||||||||||||||||||
The additional map of suffixes to content types. This map is used when working with template variants. By default, the |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
By default, REST Client Reactive uses text/plain content type for String values and application/json for everything else. MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec. This property is applicable to reactive REST clients only. |
boolean |
|
||||||||||||||||||||||||||||||
Mode in which the form data are encoded. Possible values are |
string |
|||||||||||||||||||||||||||||||
A string value in the form of |
string |
|||||||||||||||||||||||||||||||
Proxy username, equivalent to the http.proxy or https.proxy JVM settings. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Proxy password, equivalent to the http.proxyPassword or https.proxyPassword JVM settings. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
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 This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Scope of logging for the client.
WARNING: beware of logging sensitive data
The possible values are:
- |
string |
|||||||||||||||||||||||||||||||
How many characters of the body should be logged. Message body can be large and can easily pollute the logs. By default, set to 100. This property is applicable to reactive REST clients only. |
int |
|
||||||||||||||||||||||||||||||
Global default connect timeout for automatically generated REST Clients. The attribute specifies a timeout in milliseconds that a client should wait to connect to the remote endpoint. |
long |
|
||||||||||||||||||||||||||||||
Global default read timeout for automatically generated REST clients. The attribute specifies a timeout in milliseconds that a client should wait for a response from the remote endpoint. |
long |
|
||||||||||||||||||||||||||||||
If true, the reactive REST clients will not provide additional contextual information (like REST client class and method names) when exception occurs during a client invocation. |
boolean |
|
||||||||||||||||||||||||||||||
Configure the HTTP user-agent header to use. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
The base URL to use for this service. This property or the |
string |
|||||||||||||||||||||||||||||||
The base URI to use for this service. This property or the |
string |
|||||||||||||||||||||||||||||||
The CDI scope to use for injection. This property can contain either a fully qualified class name of a CDI scope annotation (such as "javax.enterprise.context.ApplicationScoped") or its simple name (such as "ApplicationScoped"). |
string |
|||||||||||||||||||||||||||||||
Map where keys are fully-qualified provider classnames to include in the client, and values are their integer priorities. The equivalent of the |
string |
|||||||||||||||||||||||||||||||
Timeout specified in milliseconds to wait to connect to the remote endpoint. |
long |
|||||||||||||||||||||||||||||||
Timeout specified in milliseconds to wait for a response from the remote endpoint. |
long |
|||||||||||||||||||||||||||||||
A boolean value used to determine whether the client should follow HTTP redirect responses. |
boolean |
|||||||||||||||||||||||||||||||
A string value in the form of |
string |
|||||||||||||||||||||||||||||||
Proxy username. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Proxy password. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Hosts to access without proxy This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
The trust store location. Can point to either a classpath resource or a file. |
string |
|||||||||||||||||||||||||||||||
The trust store password. |
string |
|||||||||||||||||||||||||||||||
The type of the trust store. Defaults to "JKS". |
string |
|||||||||||||||||||||||||||||||
The key store location. Can point to either a classpath resource or a file. |
string |
|||||||||||||||||||||||||||||||
The key store password. |
string |
|||||||||||||||||||||||||||||||
The type of the key store. Defaults to "JKS". |
string |
|||||||||||||||||||||||||||||||
The class name of the host name verifier. The class must have a public no-argument constructor. |
string |
|||||||||||||||||||||||||||||||
The time in ms for which a connection remains unused in the connection pool before being evicted and closed. A timeout of |
int |
|||||||||||||||||||||||||||||||
The size of the connection pool for this client. |
int |
|||||||||||||||||||||||||||||||
The maximum number of redirection a request can follow. This property is applicable to reactive REST clients only. |
int |
|||||||||||||||||||||||||||||||
The HTTP headers that should be applied to all requests of the rest client. |
|
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Set the HTTP client name, used when the client is shared, otherwise ignored. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Configure the HTTP user-agent header to use. This property is applicable to reactive REST clients only. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Default scope for Rest Client Reactive. Use |
string |
|
||||||||||||||||||||||||||||||
By default, RESTEasy Reactive uses text/plain content type for String values and application/json for everything else. MicroProfile Rest Client spec requires the implementations to always default to application/json. This build item disables the "smart" behavior of RESTEasy Reactive to comply to the spec |
boolean |
|
||||||||||||||||||||||||||||||
Whether providers (filters, etc.) annotated with |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
if set to true, access to all JAX-RS resources will be denied by default |
boolean |
|
||||||||||||||||||||||||||||||
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 |
list of string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If gzip is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Maximum deflated file bytes size If the limit is exceeded, Resteasy will return Response with status 413("Request Entity Too Large") |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Default charset. Note that the default value is UTF-8 which is different from RESTEasy’s default value US-ASCII. |
|
|||||||||||||||||||||||||||||||
The default content-type. |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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: |
boolean |
|
||||||||||||||||||||||||||||||
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 |
string |
|
||||||||||||||||||||||||||||||
Ignore all explicit JAX-RS |
boolean |
|
||||||||||||||||||||||||||||||
Whether annotations such |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Set this to define the application path that serves as the base URI for all JAX-RS resource URIs provided by |
string |
|||||||||||||||||||||||||||||||
Default charset. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The amount of memory that can be used to buffer input before switching to blocking IO. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
When one of the quarkus-resteasy-reactive-jackson or quarkus-resteasy-reactive-jsonb extension are active and the result type of an endpoint is an application class or one of |
boolean |
|
||||||||||||||||||||||||||||||
Whether annotations such |
boolean |
|
||||||||||||||||||||||||||||||
Whether duplicate endpoints should trigger error at startup |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The desired size (in bytes) for TDS packets. |
int |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The desired size (in bytes) for TDS packets. |
int |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Charset for connections. |
string |
|||||||||||||||||||||||||||||||
Collation for connections. |
string |
|||||||||||||||||||||||||||||||
Desired security state of the connection to the server. See MySQL Reference Manual. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Charset for connections. |
string |
|||||||||||||||||||||||||||||||
Collation for connections. |
string |
|||||||||||||||||||||||||||||||
Desired security state of the connection to the server. See MySQL Reference Manual. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum number of inflight database commands that can be pipelined. |
int |
|||||||||||||||||||||||||||||||
SSL operating mode of the client. See Protection Provided in Different Modes. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum number of inflight database commands that can be pipelined. |
int |
|||||||||||||||||||||||||||||||
SSL operating mode of the client. See Protection Provided in Different Modes. |
|
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If we create a Reactive datasource for this datasource. |
boolean |
|
||||||||||||||||||||||||||||||
Whether prepared statements should be cached on the client side. |
boolean |
|
||||||||||||||||||||||||||||||
The datasource URL. |
string |
|||||||||||||||||||||||||||||||
The datasource pool maximum size. |
int |
|||||||||||||||||||||||||||||||
When a new connection object is created, the pool assigns it an event loop.
When |
int |
|||||||||||||||||||||||||||||||
Whether all server certificates should be trusted. |
boolean |
|
||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
The number of reconnection attempts when a pooled connection cannot be established on first try. |
int |
|
||||||||||||||||||||||||||||||
The interval between reconnection attempts when a pooled connection cannot be established on first try. |
|
|||||||||||||||||||||||||||||||
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS, LDAPS or an empty string. |
string |
|||||||||||||||||||||||||||||||
The maximum time a connection remains unused in the pool before it is closed. |
|
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Set the pool name, used when the pool is shared among datasources, otherwise ignored. |
string |
|||||||||||||||||||||||||||||||
Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If we create a Reactive datasource for this datasource. |
boolean |
|
||||||||||||||||||||||||||||||
Whether prepared statements should be cached on the client side. |
boolean |
|
||||||||||||||||||||||||||||||
The datasource URL. |
string |
|||||||||||||||||||||||||||||||
The datasource pool maximum size. |
int |
|||||||||||||||||||||||||||||||
When a new connection object is created, the pool assigns it an event loop.
When |
int |
|||||||||||||||||||||||||||||||
Whether all server certificates should be trusted. |
boolean |
|
||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
The number of reconnection attempts when a pooled connection cannot be established on first try. |
int |
|
||||||||||||||||||||||||||||||
The interval between reconnection attempts when a pooled connection cannot be established on first try. |
|
|||||||||||||||||||||||||||||||
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS, LDAPS or an empty string. |
string |
|||||||||||||||||||||||||||||||
The maximum time a connection remains unused in the pool before it is closed. |
|
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Set the pool name, used when the pool is shared among datasources, otherwise ignored. |
string |
|||||||||||||||||||||||||||||||
Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. |
string |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
The redis hosts to use while connecting to the redis server. Only the cluster mode will consider more than 1 element.
The URI provided uses the following schema |
list of URI |
|
||||||||||||||||||||||||||||||
The hosts provider bean name.
It is the |
string |
|||||||||||||||||||||||||||||||
The maximum delay to wait before a blocking command to redis server times out |
|
|||||||||||||||||||||||||||||||
The redis client type |
|
|
||||||||||||||||||||||||||||||
The master name (only considered in HA mode). |
string |
|
||||||||||||||||||||||||||||||
The role name (only considered in HA mode). |
|
|
||||||||||||||||||||||||||||||
Whether to use replicas nodes (only considered in Cluster mode). |
|
|
||||||||||||||||||||||||||||||
The default password for cluster/sentinel connections.
If not set it will try to extract the value from the current default |
string |
|||||||||||||||||||||||||||||||
The maximum size of the connection pool. When working with cluster or sentinel. This value should be at least the total number of cluster member (or number of sentinels + 1) |
int |
|
||||||||||||||||||||||||||||||
The maximum waiting requests for a connection from the pool. |
int |
|
||||||||||||||||||||||||||||||
The duration indicating how often should the connection pool cleaner executes. |
||||||||||||||||||||||||||||||||
The timeout for a connection recycling. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Tune how much nested arrays are allowed on a redis response. This affects the parser performance. |
int |
|
||||||||||||||||||||||||||||||
The number of reconnection attempts when a pooled connection cannot be established on first try. |
int |
|
||||||||||||||||||||||||||||||
The interval between reconnection attempts when a pooled connection cannot be established on first try. |
|
|||||||||||||||||||||||||||||||
The maximum time a connection remains unused in the pool before it is closed. |
int |
|
||||||||||||||||||||||||||||||
Whether TCP keep alive is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Whether TCP no delay is enabled |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
The container image name to use, for container based DevServices providers. |
string |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
The redis hosts to use while connecting to the redis server. Only the cluster mode will consider more than 1 element.
The URI provided uses the following schema |
list of URI |
|
||||||||||||||||||||||||||||||
The hosts provider bean name.
It is the |
string |
|||||||||||||||||||||||||||||||
The maximum delay to wait before a blocking command to redis server times out |
|
|||||||||||||||||||||||||||||||
The redis client type |
|
|
||||||||||||||||||||||||||||||
The master name (only considered in HA mode). |
string |
|
||||||||||||||||||||||||||||||
The role name (only considered in HA mode). |
|
|
||||||||||||||||||||||||||||||
Whether to use replicas nodes (only considered in Cluster mode). |
|
|
||||||||||||||||||||||||||||||
The default password for cluster/sentinel connections.
If not set it will try to extract the value from the current default |
string |
|||||||||||||||||||||||||||||||
The maximum size of the connection pool. When working with cluster or sentinel. This value should be at least the total number of cluster member (or number of sentinels + 1) |
int |
|
||||||||||||||||||||||||||||||
The maximum waiting requests for a connection from the pool. |
int |
|
||||||||||||||||||||||||||||||
The duration indicating how often should the connection pool cleaner executes. |
||||||||||||||||||||||||||||||||
The timeout for a connection recycling. |
|
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Tune how much nested arrays are allowed on a redis response. This affects the parser performance. |
int |
|
||||||||||||||||||||||||||||||
The number of reconnection attempts when a pooled connection cannot be established on first try. |
int |
|
||||||||||||||||||||||||||||||
The interval between reconnection attempts when a pooled connection cannot be established on first try. |
|
|||||||||||||||||||||||||||||||
The maximum time a connection remains unused in the pool before it is closed. |
int |
|
||||||||||||||||||||||||||||||
Whether TCP keep alive is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Whether TCP no delay is enabled |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Enable trusting all certificates. Disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS, LDAPS or an empty string. |
string |
|||||||||||||||||||||||||||||||
Whether SSL/TLS is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Enable trusting all certificates. Disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
PEM Trust config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the trust certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
PEM Key/cert config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Comma-separated list of the path to the key files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
Comma-separated list of the path to the certificate files (Pem format). |
list of string |
|||||||||||||||||||||||||||||||
JKS config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path of the key file (JKS format). |
string |
|||||||||||||||||||||||||||||||
Password of the key file. |
string |
|||||||||||||||||||||||||||||||
PFX config is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
Path to the key file (PFX format). |
string |
|||||||||||||||||||||||||||||||
Password of the key. |
string |
|||||||||||||||||||||||||||||||
The hostname verification algorithm to use in case the server’s identity should be checked. Should be HTTPS, LDAPS or an empty string. |
string |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The syntax used in CRON expressions. |
|
|
||||||||||||||||||||||||||||||
Scheduled task metrics will be enabled if a metrics extension is present and this value is true. |
boolean |
|
||||||||||||||||||||||||||||||
If schedulers are enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Scheduled task will be flagged as overdue if next execution time is exceeded by this period. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether authorization is enabled in dev mode or not. In other launch modes authorization is always enabled. |
boolean |
|
||||||||||||||||||||||||||||||
List of security providers to register |
list of string |
|||||||||||||||||||||||||||||||
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, |
boolean |
|
||||||||||||||||||||||||||||||
Security provider configuration |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
If the WebAuthn extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
The origin of the application. The origin is basically protocol, host and port. If you are calling WebAuthn API while your application is located at |
string |
|||||||||||||||||||||||||||||||
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 |
list of AuthenticatorTransport |
|
||||||||||||||||||||||||||||||
The id (or domain name of your server) |
string |
|||||||||||||||||||||||||||||||
A user friendly name for your server |
string |
|
||||||||||||||||||||||||||||||
Kind of Authenticator Attachment allowed. Authenticators can connect to your device in two forms:
- |
|
|||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
User Verification requirements. Webauthn applications may choose |
|
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
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:
- |
|
|
||||||||||||||||||||||||||||||
Allowed Public Key Credential algorithms by preference order. Webauthn mandates that all authenticators must support at least the following 2 algorithms: |
list of PublicKeyCredential |
|
||||||||||||||||||||||||||||||
Length of the challenges exchanged between the application and the browser. Challenges must be at least 32 bytes. |
int |
|
||||||||||||||||||||||||||||||
The login page |
string |
|
||||||||||||||||||||||||||||||
The inactivity (idle) timeout When inactivity timeout is reached, cookie is not renewed and a new login is enforced. |
|
|||||||||||||||||||||||||||||||
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 as 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 users last request is when the cookie is 9m old then the actual timeout will happen 21m after the last request, as the timeout is only refreshed when a new cookie is generated. In other words, 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. |
|
|||||||||||||||||||||||||||||||
The cookie that is used to store the persistent session |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The rootPath under which queries will be served. Default to graphql By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
Enable metrics. By default, this is false. If set to true, a metrics extension is required. |
boolean |
|||||||||||||||||||||||||||||||
Enable tracing. By default, this will be enabled if the tracing extension is added. |
boolean |
|||||||||||||||||||||||||||||||
Enable validation. By default, this will be enabled if the Hibernate Validator extension is added. |
boolean |
|||||||||||||||||||||||||||||||
Enable eventing. Allow you to receive events on bootstrap and execution. |
boolean |
|
||||||||||||||||||||||||||||||
Enable non-blocking support. Default is true. |
boolean |
|||||||||||||||||||||||||||||||
Enable GET Requests. Allow queries via HTTP GET. |
boolean |
|||||||||||||||||||||||||||||||
Enable Query parameter on POST Requests. Allow POST request to override or supply values in a query parameter. |
boolean |
|||||||||||||||||||||||||||||||
Change the type naming strategy. |
|
|
||||||||||||||||||||||||||||||
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] |
list of string |
|||||||||||||||||||||||||||||||
List of Runtime Exceptions class names that should show the error message. By default, Runtime Exception messages will be hidden and a generic |
list of string |
|||||||||||||||||||||||||||||||
List of Checked Exceptions class names that should hide the error message. By default, Checked Exception messages will show the exception message. |
list of string |
|||||||||||||||||||||||||||||||
The default error message that will be used for hidden exception messages. Defaults to "Server Error" |
string |
|||||||||||||||||||||||||||||||
Print the data fetcher exception to the log file. Default |
boolean |
|||||||||||||||||||||||||||||||
Make the schema available over HTTP. |
boolean |
|
||||||||||||||||||||||||||||||
Include the Scalar definitions in the schema. |
boolean |
|
||||||||||||||||||||||||||||||
Include the schema internal definition in the schema. |
boolean |
|
||||||||||||||||||||||||||||||
Include Directives in the schema. |
boolean |
|
||||||||||||||||||||||||||||||
Include Introspection Types in the schema. |
boolean |
|
||||||||||||||||||||||||||||||
Log the payload (and optionally variables) to System out. |
|
|
||||||||||||||||||||||||||||||
Set the Field visibility. |
string |
|
||||||||||||||||||||||||||||||
Exceptions that should be unwrapped (class names). |
list of string |
|||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
If GraphQL UI should be enabled. By default, GraphQL UI is enabled if it is included (see |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The path where GraphQL UI is available. The value |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The URL location of the target GraphQL service. |
string |
|||||||||||||||||||||||||||||||
HTTP headers to add when communicating with the target GraphQL service. |
|
|||||||||||||||||||||||||||||||
WebSocket subprotocols that should be supported by this client for running GraphQL operations over websockets. Allowed values are: - |
list of string |
|
||||||||||||||||||||||||||||||
If true, then queries and mutations will run over the websocket transport rather than pure HTTP. Off by default, because it has higher overhead. |
boolean |
|||||||||||||||||||||||||||||||
Maximum time in milliseconds that will be allowed to wait for the server to acknowledge a websocket connection (send a subprotocol-specific ACK message). |
int |
|||||||||||||||||||||||||||||||
The trust store location. Can point to either a classpath resource or a file. |
string |
|||||||||||||||||||||||||||||||
The trust store password. |
string |
|||||||||||||||||||||||||||||||
The type of the trust store. Defaults to "JKS". |
string |
|||||||||||||||||||||||||||||||
The key store location. Can point to either a classpath resource or a file. |
string |
|||||||||||||||||||||||||||||||
The key store password. |
string |
|||||||||||||||||||||||||||||||
The type of the key store. Defaults to "JKS". |
string |
|||||||||||||||||||||||||||||||
Hostname of the proxy to use. |
string |
|||||||||||||||||||||||||||||||
Port number of the proxy to use. |
int |
|||||||||||||||||||||||||||||||
Username for the proxy to use. |
string |
|||||||||||||||||||||||||||||||
Password for the proxy to use. |
string |
|||||||||||||||||||||||||||||||
Maximum number of redirects to follow. |
int |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether extensions published health check should be enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Whether to include the Liveness and Readiness Health endpoints in the generated OpenAPI document |
boolean |
|
||||||||||||||||||||||||||||||
Root path for health-checking endpoints. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
The relative path of the liveness health-checking endpoint. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
The relative path of the readiness health-checking endpoint. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
The relative path of the health group endpoint. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
The relative path of the wellness health-checking endpoint. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
The relative path of the startup health-checking endpoint. By default, this value will be resolved as a path relative to |
string |
|
||||||||||||||||||||||||||||||
Whether the context should be propagated to each health check invocation. |
boolean |
|
||||||||||||||||||||||||||||||
If Health UI should be enabled. By default, Health UI is enabled if it is included (see |
boolean |
|
||||||||||||||||||||||||||||||
Additional top-level properties to be included in the resulting JSON object. |
|
|||||||||||||||||||||||||||||||
Whether the HealthCheck should be enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The path where Health UI is available. The value |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The MP-JWT configuration object |
boolean |
|
||||||||||||||||||||||||||||||
The name of the |
string |
|
||||||||||||||||||||||||||||||
Enable this property if fetching the remote keys can be a time-consuming operation. Do not enable it if you use the local keys. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The path to the metrics handler. |
string |
|
||||||||||||||||||||||||||||||
Whether metrics published by Quarkus extensions should be enabled. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Whether detailed JAX-RS metrics should be enabled. See MicroProfile Metrics: Optional REST metrics. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The path at which to register the OpenAPI Servlet. |
string |
|
||||||||||||||||||||||||||||||
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. |
path |
|||||||||||||||||||||||||||||||
Do not run the filter only at startup, but every time the document is requested (dynamic). |
boolean |
|
||||||||||||||||||||||||||||||
Do not include the provided static openapi document (eg. META-INF/openapi.yaml) |
boolean |
|
||||||||||||||||||||||||||||||
A list of local directories that should be scanned for yaml and/or json files to be included in the static model. Example: |
list of path |
|||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
Add a Security Scheme name to the generated OpenAPI document |
string |
|
||||||||||||||||||||||||||||||
Add a description to the Security Scheme |
string |
|
||||||||||||||||||||||||||||||
This will automatically add the security requirement to all methods/classes that has a |
boolean |
|
||||||||||||||||||||||||||||||
This will automatically add tags to operations based on the Java class name. |
boolean |
|
||||||||||||||||||||||||||||||
Setting it to |
boolean |
|||||||||||||||||||||||||||||||
This will automatically add security based on the security extension included (if any). |
boolean |
|
||||||||||||||||||||||||||||||
Add a scheme value to the Basic HTTP Security Scheme |
string |
|
||||||||||||||||||||||||||||||
Add a scheme value to the JWT Security Scheme |
string |
|
||||||||||||||||||||||||||||||
Add a scheme value to the JWT Security Scheme |
string |
|
||||||||||||||||||||||||||||||
Add a openIdConnectUrl value to the OIDC Security Scheme |
string |
|||||||||||||||||||||||||||||||
Add a implicit flow refreshUrl value to the OAuth2 Security Scheme |
string |
|||||||||||||||||||||||||||||||
Add an implicit flow authorizationUrl value to the OAuth2 Security Scheme |
string |
|||||||||||||||||||||||||||||||
Add an implicit flow tokenUrl value to the OAuth2 Security Scheme |
string |
|||||||||||||||||||||||||||||||
Override the openapi version in the Schema document |
string |
|||||||||||||||||||||||||||||||
Specify the list of global servers that provide connectivity information |
list of string |
|||||||||||||||||||||||||||||||
Set the title in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the version in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the description in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the terms of the service in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the contact email in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the contact name in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the contact url in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the license name in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the license url in Info tag in the Schema document |
string |
|||||||||||||||||||||||||||||||
Set the strategy to automatically create an operation Id |
|
|||||||||||||||||||||||||||||||
Enable the openapi endpoint. By default it’s enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether a health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
Whether Reactive Messaging metrics are published in case a metrics extension is present (default to false). |
boolean |
|
||||||||||||||||||||||||||||||
Enables or disables the strict validation mode. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The image to use. Note that only |
string |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Whether or not Kafka serializer/deserializer auto-detection is enabled. |
boolean |
|
||||||||||||||||||||||||||||||
Whether Kafka serializer/deserializer generation is enabled. When no serializer/deserializer are found and not set, Quarkus generates a Jackson-based serde. |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
boolean |
|||||||||||||||||||||||||||||||
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. |
int |
|||||||||||||||||||||||||||||||
The image to use. |
string |
|
||||||||||||||||||||||||||||||
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 |
boolean |
|
||||||||||||||||||||||||||||||
The value of the |
string |
|
||||||||||||||||||||||||||||||
The credentials provider name. |
string |
|||||||||||||||||||||||||||||||
The credentials provider bean name.
It is the |
string |
|||||||||||||||||||||||||||||||
Type of exchange: direct, topic, headers, fanout, etc. |
string |
|
||||||||||||||||||||||||||||||
Should the exchange be deleted when all queues are finished using it? |
boolean |
|
||||||||||||||||||||||||||||||
Should the exchange remain after restarts? |
boolean |
|
||||||||||||||||||||||||||||||
Extra arguments for the exchange definition. |
|
|||||||||||||||||||||||||||||||
Should the queue be deleted when all consumers are finished using it? |
boolean |
|
||||||||||||||||||||||||||||||
Should the queue remain after restarts? |
boolean |
|
||||||||||||||||||||||||||||||
Extra arguments for the queue definition. |
|
|||||||||||||||||||||||||||||||
Source exchange to bind to. Defaults to name of binding instance. |
string |
|||||||||||||||||||||||||||||||
Routing key specification for the source exchange. |
string |
|
||||||||||||||||||||||||||||||
Destination exchange or queue to bind to. Defaults to name of binding instance. |
string |
|||||||||||||||||||||||||||||||
Destination type for binding: queue, exchange, etc. |
string |
|
||||||||||||||||||||||||||||||
Extra arguments for the binding definition. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
Configures the service discovery type, e.g. "consul". ServiceDiscoveryProvider for the type has to be available |
string |
required |
||||||||||||||||||||||||||||||
ServiceDiscovery parameters. Check the documentation of the selected service discovery type for available parameters. |
|
|||||||||||||||||||||||||||||||
Configures load balancer type, e.g. "round-robin". A LoadBalancerProvider for the type has to be available |
string |
|
||||||||||||||||||||||||||||||
Load Balancer parameters. Check the documentation of the selected load balancer type for available parameters |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The path where Swagger UI is available.
The value |
string |
|
||||||||||||||||||||||||||||||
If this should be included every time. By default, this is only included when the application is running in dev mode. |
boolean |
|
||||||||||||||||||||||||||||||
If urls option is used, this will be the name of the default selection. |
string |
|||||||||||||||||||||||||||||||
The html title for the page. |
string |
|||||||||||||||||||||||||||||||
Swagger UI theme to be used. |
|
|||||||||||||||||||||||||||||||
A footer for the html page. Nothing by default. |
string |
|||||||||||||||||||||||||||||||
If set to true, enables deep linking for tags and operations. |
boolean |
|||||||||||||||||||||||||||||||
Controls the display of operationId in operations list. The default is false. |
boolean |
|||||||||||||||||||||||||||||||
The default expansion depth for models (set to -1 completely hide the models). |
int |
|||||||||||||||||||||||||||||||
The default expansion depth for the model on the model-example section. |
int |
|||||||||||||||||||||||||||||||
Controls how the model is shown when the API is first rendered. |
string |
|||||||||||||||||||||||||||||||
Controls the display of the request duration (in milliseconds) for "Try it out" requests. |
boolean |
|||||||||||||||||||||||||||||||
Controls the default expansion setting for the operations and tags. |
|
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
If set, limits the number of tagged operations displayed to at most this many. The default is to show all operations. |
int |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Controls the display of vendor extension (x-) fields and values for Operations, Parameters, and Schema. |
boolean |
|||||||||||||||||||||||||||||||
Controls the display of extensions (pattern, maxLength, minLength, maximum, minimum) fields and values for Parameters. |
boolean |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
Provides a mechanism to be notified when Swagger UI has finished rendering a newly provided definition. |
string |
|||||||||||||||||||||||||||||||
Set to |
string |
|||||||||||||||||||||||||||||||
OAuth redirect URL. |
string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
list of string |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
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. |
list of HttpMethod |
|||||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||||
If set to true, enables passing credentials, as defined in the Fetch standard, in CORS requests that are sent by the browser. |
boolean |
|||||||||||||||||||||||||||||||
Function to set default values to each property in model. Accepts one argument modelPropertyMacro(property), property is immutable |
string |
|||||||||||||||||||||||||||||||
Function to set default value to parameters. Accepts two arguments parameterMacro(operation, parameter). Operation and parameter are objects passed for context, both remain immutable |
string |
|||||||||||||||||||||||||||||||
If set to true, it persists authorization data and it would not be lost on browser close/refresh |
boolean |
|||||||||||||||||||||||||||||||
The name of a component available via the plugin system to use as the top-level layout for Swagger UI. |
string |
|||||||||||||||||||||||||||||||
A list of plugin functions to use in Swagger UI. |
list of string |
|||||||||||||||||||||||||||||||
A list of presets to use in Swagger UI. |
list of string |
|||||||||||||||||||||||||||||||
OAuth default clientId - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth default clientSecret - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth1 Realm query parameter added to authorizationUrl and tokenUrl - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth application name, displayed in authorization popup - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth scope separator for passing scopes - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth Scopes, separated using the oauthScopeSeparator - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
OAuth additional query parameters added to authorizationUrl and tokenUrl - Used in the initOAuth method. |
string |
|||||||||||||||||||||||||||||||
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. |
boolean |
|||||||||||||||||||||||||||||||
OAuth only applies to authorization code flows. Proof Key for Code Exchange brings enhanced security for OAuth public clients - Used in the initOAuth method. |
boolean |
|||||||||||||||||||||||||||||||
Pre-authorize Basic Auth, programmatically set DefinitionKey for a Basic authorization scheme - Used in the preauthorizeBasic method. |
string |
|||||||||||||||||||||||||||||||
Pre-authorize Basic Auth, programmatically set Username for a Basic authorization scheme - Used in the preauthorizeBasic method. |
string |
|||||||||||||||||||||||||||||||
Pre-authorize Basic Auth, programmatically set Password for a Basic authorization scheme - Used in the preauthorizeBasic method. |
string |
|||||||||||||||||||||||||||||||
Pre-authorize ApiKey Auth, programmatically set DefinitionKey for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method. |
string |
|||||||||||||||||||||||||||||||
Pre-authorize ApiKey Auth, programmatically set ApiKeyValue for an API key or Bearer authorization scheme - Used in the preauthorizeApiKey method. |
string |
|||||||||||||||||||||||||||||||
If Swagger UI is included, it should be enabled/disabled. By default, Swagger UI is enabled if it is included (see |
boolean |
|
||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
string |
|||||||||||||||||||||||||||||||
The default charset to use for reading and writing requests |
string |
|
||||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||||
If Servlet should use direct buffers, this gives maximum performance but can be problematic in memory constrained environments |
boolean |
|||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The maximum amount of data that can be sent in a single frame. Messages larger than this must be broken up into continuation frames. |
int |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
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 |
string |
|
||||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||||
Start gRPC server in dev mode even if no gRPC services are implemented. By default set to |
boolean |
|
||||||||||||||||||||||||||||||
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. |
boolean |
|
||||||||||||||||||||||||||||||
Whether a health check on gRPC status is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||||
Whether the gRPC health check is exposed. |
boolean |
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The gRPC service port. |
int |
|
||||||||||||||||||||||||||||||
The host name / IP on which the service is exposed. |
string |
required |
||||||||||||||||||||||||||||||
The classpath path or file path to a server certificate or certificate chain in PEM format. |
path |
|||||||||||||||||||||||||||||||
The classpath path or file path to the corresponding certificate private key file in PEM format. |
path |
|||||||||||||||||||||||||||||||
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. |
path |
|||||||||||||||||||||||||||||||
Use a name resolver. Defaults to dns. If set to "stork", host will be treated as SmallRye Stork service name |
string |
|
||||||||||||||||||||||||||||||
Whether |
boolean |
|||||||||||||||||||||||||||||||
The duration after which a keep alive ping is sent. |
||||||||||||||||||||||||||||||||
The flow control window in bytes. Default is 1MiB. |
int |
|||||||||||||||||||||||||||||||
The duration without ongoing RPCs before going to idle mode. |
||||||||||||||||||||||||||||||||
The amount of time the sender of a keep alive ping waits for an acknowledgement. |
||||||||||||||||||||||||||||||||
Whether keep-alive will be performed when there are no outstanding RPC on a connection. |
boolean |
|
||||||||||||||||||||||||||||||
The max number of hedged attempts. |
int |
|
||||||||||||||||||||||||||||||
The max number of retry attempts. Retry must be explicitly enabled. |
int |
|
||||||||||||||||||||||||||||||
The maximum number of channel trace events to keep in the tracer for each channel or sub-channel. |
int |
|||||||||||||||||||||||||||||||
The maximum message size allowed for a single gRPC frame (in bytes). Default is 4 MiB. |
int |
|||||||||||||||||||||||||||||||
The maximum size of metadata allowed to be received (in bytes). Default is 8192B. |
int |
|||||||||||||||||||||||||||||||
The negotiation type for the HTTP/2 connection. Accepted values are: |
string |
|
||||||||||||||||||||||||||||||
Overrides the authority used with TLS and HTTP virtual hosting. |
string |
|||||||||||||||||||||||||||||||
The per RPC buffer limit in bytes used for retry. |
long |
|||||||||||||||||||||||||||||||
Whether retry is enabled. Note that retry is disabled by default. |
boolean |
|
||||||||||||||||||||||||||||||
The retry buffer size in bytes. |
long |
|||||||||||||||||||||||||||||||
Use a custom user-agent. |
string |
|||||||||||||||||||||||||||||||
Use a custom load balancing policy. Accepted values are: |
string |
|
||||||||||||||||||||||||||||||
The compression to use for each call. The accepted values are |
string |
|||||||||||||||||||||||||||||||
The deadline used for each call.
The format uses the standard |
||||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||||
The gRPC Server port. |
int |
|
||||||||||||||||||||||||||||||
The gRPC Server port used for tests. |
int |
|
||||||||||||||||||||||||||||||
The gRPC server host. |
string |
|
||||||||||||||||||||||||||||||
The gRPC handshake timeout. |
||||||||||||||||||||||||||||||||
The max inbound message size in bytes. |
int |
|||||||||||||||||||||||||||||||
The max inbound metadata size in bytes |
int |
|||||||||||||||||||||||||||||||
The classpath path or file path to a server certificate or certificate chain in PEM format. |
path |
|||||||||||||||||||||||||||||||
The classpath path or file path to the corresponding certificate private key file in PEM format. |
path |
|||||||||||||||||||||||||||||||
An optional key store which holds the certificate information instead of specifying separate files. The key store can be either on classpath or an external file. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify the type of the key store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||||||||||||||||||||||||||||||
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. |
path |
|||||||||||||||||||||||||||||||
An optional parameter to specify type of the trust store file. If not given, the type is automatically detected based on the file name. |
string |
|||||||||||||||||||||||||||||||
A parameter to specify the password of the trust store file. |
string |
|||||||||||||||||||||||||||||||
The cipher suites to use. If none is given, a reasonable default is selected. |
list of string |
|||||||||||||||||||||||||||||||
The list of protocols to explicitly enable. |
list of string |
|
||||||||||||||||||||||||||||||
Configures the engine to require/request client authentication. NONE, REQUEST, REQUIRED |
|
|
||||||||||||||||||||||||||||||
Disables SSL, and uses plain text instead. If disabled, configure the ssl configuration. |
boolean |
|
||||||||||||||||||||||||||||||
Whether ALPN should be used. |
boolean |
|
||||||||||||||||||||||||||||||
The path to the certificate file. |
string |
|||||||||||||||||||||||||||||||
The path to the private key file. |
string |
|||||||||||||||||||||||||||||||
Enables the gRPC Reflection Service. By default, the reflection service is only exposed in |
boolean |
|
||||||||||||||||||||||||||||||
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. |
int |
|
||||||||||||||||||||||||||||||
Sets a custom keep-alive duration. This configures the time before sending a |
||||||||||||||||||||||||||||||||
gRPC compression, e.g. "gzip" |
string |
About the Duration format
The format for durations uses the standard You can also provide duration values starting with a number.
In this case, if the value consists only of a number, the converter treats the value as seconds.
Otherwise, |
About the MemorySize format
A size configuration option recognises string in this format (shown as a regular expression): |