Configuration property fixed at build time - ️ Configuration property overridable at runtime
Type |
Default |
|||
---|---|---|---|---|
The handler name. Handler names are specified on handler classes using the |
string |
|||
If true, this will enable the aws event poll loop within a Quarkus test run. This loop normally only runs in native image. This option is strictly for testing purposes. |
boolean |
|
||
Type |
Default |
|||
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 |
|
|
||
Whether or not an healtcheck is published in case the smallrye-health extension is present (default to true). |
boolean |
|
||
The datasource URL |
string |
|||
The datasource username |
string |
|||
The datasource password |
string |
|||
The credentials provider name |
string |
|||
The credentials provider type.
It is the |
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 |
|
|||
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. |
|
|||
Enable datasource metrics collection. |
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 |
|||
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 |
|
|
||
The datasource URL |
string |
|||
The datasource username |
string |
|||
The datasource password |
string |
|||
The credentials provider name |
string |
|||
The credentials provider type.
It is the |
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 |
|
|||
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. |
|
|||
Enable datasource metrics collection. |
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 |
|||
Type |
Default |
|||
Enable DynamoDB service endpoint discovery. |
boolean |
|
||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for DynamoDB service and region. |
||||
The amount of time to allow the client to complete the execution of an API call. This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. This value should always be positive, if present. |
||||
The amount of time to wait for the HTTP request to complete before giving up and timing out. This value should always be positive, if present. |
||||
List of execution interceptors that will have access to read and modify the request and response objects as they are processed by the AWS SDK.
The list should consists of class names which implements |
list of class name |
required |
||
An Amazon Web Services region that hosts DynamoDB. It overrides region provider chain with static value of region with which the DynamoDB client should communicate. If not set, region is retrieved via the default providers chain in the following order:
See |
Region |
|||
Configure the credentials provider that should be used to authenticate with AWS. Available values:
|
|
|
||
Whether this provider should fetch credentials asynchronously in the background.
If this is |
boolean |
|
||
Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. |
boolean |
|
||
AWS Access key id |
string |
required |
||
AWS Secret access key |
string |
required |
||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||
Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. |
boolean |
|
||
The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed before they are reported to expire. |
|
|||
The maximum size of the output that can be returned by the external process before an exception is raised. |
|
|||
The command that should be executed to retrieve credentials. |
string |
required |
||
Type of the sync HTTP client implementation |
|
|
||
The maximum amount of time to establish a connection before timing out. |
|
|||
The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. |
|
|||
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. |
|
|||
The maximum amount of time that a connection should be allowed to remain open while idle. |
|
|||
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. |
||||
The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. |
int |
|
||
Whether the client should send an HTTP expect-continue handshake before each request. |
boolean |
|
||
Whether the idle connections in the connection pool should be closed asynchronously.
When enabled, connections left idling for longer than |
boolean |
|
||
Enable HTTP proxy |
boolean |
|
||
The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. |
required |
|||
The username to use when connecting through a proxy. |
string |
|||
The password to use when connecting through a proxy. |
string |
|||
For NTLM proxies - the Windows domain name to use when authenticating with the proxy. |
string |
|||
For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. |
string |
|||
Whether to attempt to authenticate preemptively against the proxy server using basic authentication. |
boolean |
|||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
required |
||
TLS managers provider type. Available providers:
|
|
|
||
Path to the key store. |
path |
required |
||
Key store type. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard keystore types. |
string |
required |
||
string |
required |
|||
The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. |
int |
|
||
The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. |
int |
|
||
The amount of time to wait for a read on a socket before an exception is thrown.
Specify |
|
|||
The amount of time to wait for a write on a socket before an exception is thrown.
Specify |
|
|||
The amount of time to wait when initially establishing a connection before giving up and timing out. |
|
|||
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. |
|
|||
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. |
||||
The maximum amount of time that a connection should be allowed to remain open while idle.
Currently has no effect if |
|
|||
Whether the idle connections in the connection pool should be closed.
When enabled, connections left idling for longer than |
boolean |
|
||
The HTTP protocol to use. |
|
|
||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. 0 means unlimited. |
int |
|
||
The SSL Provider to be used in the Netty client.
Default is |
|
|||
Enable HTTP proxy. |
boolean |
|
||
The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. |
required |
|||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
required |
||
TLS managers provider type. Available providers:
|
|
|
||
Path to the key store. |
path |
required |
||
Key store type. See the KeyStore section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard keystore types. |
string |
required |
||
Key store password |
string |
required |
||
Enable the custom configuration of the Netty event loop group. |
boolean |
|
||
Number of threads to use for the event loop group.
If not set, the default Netty thread count is used (which is double the number of available processors unless the |
int |
|||
The thread name prefix for threads created by this thread factory used by event loop group.
The prefix will be appended with a number unique to the thread factory and a number unique to the thread.
If not specified it defaults to |
string |
|||
Type |
Default |
|||
A unique identifier for this Kafka Streams application. |
string |
required |
||
A comma-separated list of host:port pairs identifying the Kafka bootstrap server(s) |
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. |
list of string |
required |
||
Type |
Default |
|||
The resource path within the application artifact to the |
string |
|||
Comma separated list of the parsers which must be supported.
Most of the document formats recognized by Apache Tika are supported by default but it affects the application memory and native executable sizes. One can list only the required parsers in |
string |
|||
Controls how the content of the embedded documents is parsed. By default it is appended to the master document content. Setting this property to false makes the content of each of the embedded documents available separately. |
boolean |
|
||
Type |
Default |
|||
|
string |
|
||
If set to true |
boolean |
|
||
Type |
Default |
|||
Artemis connection url |
string |
required |
||
Username for authentication, only used with JMS |
string |
|||
Password for authentication, only used with JMS |
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. Default is 2s. |
||||
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. Default is 10s. |
||||
The size of the internal thread pool (used for the file system). |
int |
|
||
Enables the async DNS resolver. |
boolean |
|
||
Comma-separated list of the path to the key files (Pem format). |
string |
|||
Comma-separated list of the path to the certificate files (Pem format). |
string |
|||
Path of the key file (JKS format). |
string |
|||
Password of the key file. |
string |
|||
Path to the key file (PFX format) |
string |
|||
Password of the key. |
string |
|||
Comma-separated list of the trust certificate files (Pem format). |
string |
|||
Path of the key file (JKS format). |
string |
|||
Password of the key file. |
string |
|||
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 or not to reuse the address. |
boolean |
|
||
Whether or not to reuse the port. |
boolean |
|
||
The send buffer size. |
int |
|||
The so linger. |
int |
|||
Enables or Disabled SSL. |
boolean |
|
||
Whether or not 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. |
|
|||
Type |
Default |
|||
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, unless an |
boolean |
|
||
If form authentication is enabled |
boolean |
|
||
The login page |
string |
|
||
The error page |
string |
|
||
The landing page to redirect to if there is no saved page to redirect back to |
string |
required |
||
The inactivity timeout |
|
|||
How old a cookie can get before it will be replaced with a new cookie with an updated timeout. Not 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. |
|
|||
The cookie that is used to store the persistent session |
string |
|
||
The authentication realm |
string |
|
||
Enable the CORS filter. |
boolean |
|
||
The HTTP port |
int |
|
||
The HTTP port used to run tests |
int |
|
||
The HTTP host |
string |
|
||
The HTTPS port |
int |
|
||
The HTTPS port used to run tests |
int |
|
||
Origins allowed for CORS Comma separated list of valid URLs. ex: http://www.quarkus.io,http://localhost:3000 The filter allows any origin if this is not set. default: returns any requested origin as valid |
list of string |
required |
||
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 |
required |
||
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 |
required |
||
HTTP headers exposed in CORS Comma separated list of valid headers. ex: X-Custom,Content-Disposition default: empty |
list of string |
required |
||
The |
||||
The file path to a server certificate or certificate chain in PEM format. |
path |
|||
The 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. |
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 |
|||
A parameter to specify the password of the key store file. If not given, the default ("password") is used. |
string |
|
||
The cipher suites to use. If none is given, a reasonable default is selected. |
list of string |
required |
||
The list of protocols to explicitly enable. |
list of string |
|
||
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 |
|||
If this is true then only a virtual channel will be set up for vertx web. We have this switch for testing purposes. |
boolean |
|
||
The the maximum length of all headers. |
|
|||
The maximum size of a request body. Default: no limit. |
||||
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 |
required |
||
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 |
required |
||
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 over matches without methods set, otherwise the most restrictive permissions are applied. |
list of string |
required |
||
The roles that are allowed to access resources protected by this policy |
list of string |
required |
||
Type |
Default |
|||
The realm name |
string |
|
||
If the properties store is enabled. |
boolean |
|
||
The sql query to find the password |
string |
required |
||
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 |
required |
||
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 |
|||
Determine if the OAuth2 extension is enabled. Enabled by default if you include the |
boolean |
|
||
The OAuth2 client id used to validate the token. |
string |
required |
||
The OAuth2 client secret used to validate the token. |
string |
required |
||
The OAuth2 introspection endpoint URL used to validate the token and gather the authentication claims. |
string |
required |
||
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 |
|||
The claim that is used in the introspection endpoint response to load the roles. |
string |
|
||
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 |
required |
||
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 |
|||
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 |
required |
||
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 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 |
|||
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 |
|||
Name of the file containing the SQL statements to execute when Hibernate ORM starts. Its default value differs depending on the Quarkus launch mode:
If you need different SQL statements between dev mode, test ( application.properties
|
string |
|
||
The size of the batches used when loading entities and collections.
|
int |
|
||
Whether statistics collection is enabled. |
boolean |
|
||
Type |
Default |
|||
The maximum size of the query plan cache. |
string |
|||
Default precedence of null values in Valid values are: |
string |
|||
Type |
Default |
|||
Select whether the database schema is generated or not. |
string |
|
||
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 |
|||
The charset of the database. |
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 |
|||
Show SQL logs and format them nicely. Setting it to true is obviously not recommended in production. |
boolean |
|
||
Whether JDBC warnings should be collected and logged. |
boolean |
|
||
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 |
|||
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 |
|||
The class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers). |
class name |
|||
If not using the default backend configuration, the name of the default backend that is part of the |
string |
|||
The class or the name of the bean that should be notified of any failure occurring in a background process (mainly index operations).
Must implement |
class name |
|||
The list of hosts of the Elasticsearch servers. |
list of string |
required |
||
The username used for authentication. |
string |
|||
The password used for authentication. |
string |
|||
The connection timeout. |
||||
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 scheme that should be used for the new nodes discovered. |
string |
|||
The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop. |
|
|||
The minimal cluster status required. Must be one of: green, yellow, red. |
|
|||
How long we should wait for the status before failing the bootstrap. |
||||
The strategy to use when loading entities during the execution of a search query. Can be either one of "skip", "persistence-context" or "persistence-context-then-second-level-cache". Defaults to "skip". |
|
|||
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 the status for which you wait before considering the operation completed by Hibernate Search. Can be either one of "queued", "committed" or "searchable". Using "searchable" is recommended in unit tests. Defaults to "committed". |
|
|||
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 |
|||
The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop. |
|
|||
The minimal cluster status required. Must be one of: green, yellow, red. |
|
|||
How long we should wait for the status before failing the bootstrap. |
||||
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 |
|||
The class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers). |
class name |
|||
The list of hosts of the Elasticsearch servers. |
list of string |
required |
||
The username used for authentication. |
string |
|||
The password used for authentication. |
string |
|||
The connection timeout. |
||||
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 scheme that should be used for the new nodes discovered. |
string |
|||
The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop. |
|
|||
The minimal cluster status required. Must be one of: green, yellow, red. |
|
|||
How long we should wait for the status before failing the bootstrap. |
||||
The strategy used for index lifecycle. Must be one of: none, validate, update, create, drop-and-create or drop-and-create-and-drop. |
|
|||
The minimal cluster status required. Must be one of: green, yellow, red. |
|
|||
How long we should wait for the status before failing the bootstrap. |
||||
Type |
Default |
|||
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 |
|||
Sets client intelligence used by authentication |
string |
|||
Enables or disables authentication |
string |
|||
Sets user name 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 used by authentication |
string |
|||
Sets callback handler used by authentication |
string |
|||
Sets SASL mechanism used by authentication |
string |
|||
Type |
Default |
|||
The configured Infinispan embeddex xml file which is used by the managed EmbeddedCacheManager and its Caches |
string |
|||
Type |
Default |
|||
List of security providers to enable for reflection |
list of string |
required |
||
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 |
|
||
Defines if the Jaeger extension is enabled. |
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 |
|||
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 |
|
||
Enables policy enforcement. |
boolean |
|
||
Specifies how policies are enforced. |
string |
|
||
Defines the time in milliseconds when the entry should be expired |
int |
|
||
Defines the limit of entries that should be kept in the cache |
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 or not 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 |
|
|
||
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> |
required |
|||
required |
||||
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> |
required |
|||
required |
||||
Type |
Default |
|||
Whether or not 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 |
|||
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 |
required |
|||
Type |
Default |
|||
Configure the default |
string |
|||
Enables the mock mode, not sending emails. The content of the emails is printed on the console. Disabled by default on PROD, enabled by default on DEV and TEST modes. |
boolean |
|||
Configures the default bounce email address. |
string |
|||
The SMTP host name. |
string |
|
||
The SMTP port. |
int |
|||
The username. |
string |
|||
The password. |
string |
|||
Enables or disables the SSL on connect. |
boolean |
|
||
Set whether to trust all certificates on ssl connect the option is also applied to |
boolean |
|
||
Configures the maximum allowed number of open connections to the mail server If not set the default is |
int |
|||
The hostname to be used for HELO/EHLO and the Message-ID |
string |
|||
Set if connection pool is enabled, |
boolean |
|
||
Disable ESMTP. |
boolean |
|
||
Set the TLS security mode for the connection. Either |
string |
|||
Set the login mode for the connection. Either |
string |
|||
Set the allowed auth methods. If defined, only these methods will be used, if the server supports them. |
string |
|||
Set the key store. |
string |
|||
Set the key store password. |
string |
|||
Type |
Default |
|||
Configures the connection string. The format is: |
string |
|||
Configures the Mongo server addressed (one if single mode). The addressed are passed as |
list of string |
required |
||
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 life time of a pooled connection. A connection that exceeds this limit will be closed. |
||||
The maximum wait time that a thread may wait for a connection to become available. |
||||
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. |
||||
This multiplier, multiplied with the |
int |
|||
How long a connection can take to be opened before timing out. |
||||
How long a send or receive on a socket 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 preferences. Supported values are: |
string |
|||
Configures the maximum number of concurrent operations allowed to wait for a server to become available. All further operations will get an exception immediately. |
int |
|||
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 |
||||
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: |
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. |
required |
|||
Type |
Default |
|||
The node name used by the transaction manager |
string |
|
||
The XA node name used by the transaction manager |
string |
|||
The default transaction timeout |
|
|||
Type |
Default |
|||
The uri this driver should connect to. The driver supports bolt, bolt+routing or neo4j as schemes. |
string |
|
||
Type |
Default |
|||
The login of the user connecting to the database. |
string |
|
||
The password of the user connecting to the database. |
string |
|
||
Set this to true to disable authentication. |
boolean |
|
||
Type |
Default |
|||
Flag, if metrics are enabled. |
boolean |
|
||
Flag, if leaked sessions logging is enabled. |
boolean |
|
||
The maximum amount of connections in the connection pool towards a single database. |
int |
|
||
Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again. The value |
|
|||
Pooled connections older than this threshold will be closed and removed from the pool. |
|
|||
Acquisition of new connections will be attempted for at most configured timeout. |
|
|||
Type |
Default |
|||
If the OIDC extension is enabled. |
boolean |
|
||
The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. All the other OIDC server page and service URLs are derived from this URL. Note if you work with Keycloak OIDC server, make sure the base URL is in the following format: 'https://host:port/auth/realms/{realm}' where '{realm}' has to be replaced by the name of the Keycloak realm. |
string |
required |
||
Relative path of the RFC7662 introspection service. |
string |
|||
Relative path of the OIDC service returning a JWK set. |
string |
|||
Public key for the local JWT token verification. |
string |
|||
The client-id of the application. Each application has a client-id that is used to identify the application |
string |
|||
Path to the claim containing an array of groups. It 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". This property can be used if a token has no 'groups' claim but has the groups set in a different claim. |
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 a custom claim whose value is a string. A single space will be used by default because the standard 'scope' claim may contain a space separated sequence. |
string |
|||
The client secret |
string |
|||
Defines a fixed list of scopes which should be added to authorization requests when authenticating users using the Authorization Code Grant Type. |
list of string |
required |
||
The application type, which can be one of the following values from enum |
|
|
||
Type |
Default |
|||
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 |
|
||
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 whether security via the embedded realm is enabled. |
boolean |
|
||
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 requested output type. The default built in types are jar and native |
string |
|
||
If the java runner should be packed as an uberjar |
boolean |
|
||
The entry point of the application. In most cases this should not be modified. |
string |
|
||
Files that should not be copied to the output artifact |
list of string |
required |
||
The suffix that is applied to the runner jar and native images |
string |
|
||
The name of the application. If not set, defaults to the name of the project. |
string |
required |
||
The version of the application. If not set, defaults to the version of the project |
string |
required |
||
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 |
|
||
If debug symbols should be included |
boolean |
|
||
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 Substrate internals |
boolean |
|
||
If the debug port should be published when building with docker and debug-build-process is true |
boolean |
|
||
If the native image server should be restarted |
boolean |
|
||
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 all security services should be added to the native image |
boolean |
|
||
This will report on the size of the retained heap after image build |
boolean |
|
||
This enables reporting of the code size of the native image |
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 |
|
||
The location of the Graal distribution |
string |
|
||
The location of the JDK |
|
|||
If the native image server should be used. This can speed up compilation but can result in changes not always being picked up due to cache invalidation not working 100% |
boolean |
|
||
If JNI should be enabled |
boolean |
|
||
If all META-INF/services entries should be automatically registered |
boolean |
|
||
If the bytecode of all proxies should be dumped for inspection |
boolean |
|
||
The default maximum old generation size of the native image |
string |
|||
If this build should be done using a container runtime. If this is set docker will be used by default, unless container-runtime is also set. |
boolean |
|
||
The docker image to use to do the image build |
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. |
string |
required |
||
Options to pass to the container runtime |
list of string |
required |
||
If the resulting image should allow VM introspection |
boolean |
|
||
If full stack traces are enabled in the resulting image |
boolean |
|
||
If reporting on call paths should be enabled |
boolean |
|
||
Additional arguments to pass to the build process |
list of string |
required |
||
If all character sets should be added to the native image. This increases image size |
boolean |
|
||
If exceptions should be reported with a full stack trace |
boolean |
|
||
The default log level |
||||
The default minimum log level |
|
|||
The core thread pool size. This number of threads will always be kept alive. |
int |
|
||
The maximum number of threads. If this is not specified then it will be automatically sized to 8 * the number of available processors |
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. |
|
|||
Type |
Default |
|||
The minimum level that this category can be set to |
string |
|
||
The log level level for this category |
string |
|
||
Type |
Default |
|||
If console logging should be enabled |
boolean |
|
||
The log format |
string |
|
||
The console log level |
|
|||
If the console logging should be in color. If undefined quarkus takes best guess based on operating system and environment. |
boolean |
|||
Specify how much the colors should be darkened |
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. Example fileSuffix: .yyyy-MM-dd |
string |
|||
Indicates whether to rotate log files on server initialization. |
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 |
|
||
Type |
Default |
|||
if set to true, access to all JAX-RS resources will be denied by default |
boolean |
|
||
Type |
Default |
|||
The datasource URL. |
string |
|||
The datasource username. |
string |
|||
The datasource password. |
string |
|||
The datasource pool maximum size. |
int |
|||
Whether prepared statements should be cached on the client side. |
boolean |
|||
Charset for connections. |
string |
|||
Collation for connections. |
string |
|||
Type |
Default |
|||
Whether prepared statements should be cached on the client side. |
boolean |
|||
The maximum number of inflight database commands that can be pipelined. |
int |
|||
The datasource URL. |
string |
|||
The datasource username. |
string |
|||
The datasource password. |
string |
|||
The datasource pool maximum size. |
int |
|||
Type |
Default |
|||
Whether or not extensions published health check should be enabled. |
boolean |
|
||
Type |
Default |
|||
The MP-JWT configuration object |
boolean |
|
||
The name of the |
string |
|
||
Type |
Default |
|||
The context path to serve all Servlet context from. This will also affect any resources that run as a Servlet, e.g. JAX-RS. Note that this is relative to the HTTP root path set in quarkus.http.root-path, so if the context path is /bar and the http root is /foo then the actual Servlet path will be /foo/bar. |
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 |
|||
Type |
Default |
|||
Vault server url. Example: https://localhost:8200 |
||||
Vault token, bypassing Vault authentication (kubernetes, userpass or approle). This is useful in development where an authentication mode might not have been set up. In production we will usually prefer some authentication such as userpass, or preferably kubernetes, where Vault tokens get generated with a TTL and some ability to revoke them. |
string |
|||
Role Id for AppRole auth method. This property is required when selecting the app-role authentication type. |
string |
|||
Secret Id for AppRole auth method. This property is required when selecting the app-role authentication type. |
string |
|||
User for userpass auth method. This property is required when selecting the userpass authentication type. |
string |
|||
Password for userpass auth method. This property is required when selecting the userpass authentication type. |
string |
|||
Kubernetes authentication role that has been created in Vault to associate Vault policies, with Kubernetes service accounts and/or Kubernetes namespaces. This property is required when selecting the Kubernetes authentication type. |
string |
|||
Location of the file containing the Kubernetes JWT token to authenticate against in Kubernetes authentication mode. |
string |
|
||
Renew grace period duration. This value if used to extend a lease before it expires its ttl, or recreate a new lease before the current lease reaches its max_ttl. By default Vault leaseDuration is equal to 7 days (ie: 168h or 604800s). If a connection pool maxLifetime is set, it is reasonable to set the renewGracePeriod to be greater than the maxLifetime, so that we are sure we get a chance to renew leases before we reach the ttl. In any case you need to make sure there will be attempts to fetch secrets within the renewGracePeriod, because that is when the renewals will happen. This particularly important for db dynamic secrets because if the lease reaches its ttl or max_ttl, the password of the db user will become invalid and it will be not longer possible to log in. This value should also be smaller than the ttl, otherwise that would mean that we would try to recreate leases all the time. |
|
|||
Vault config source cache period. Properties fetched from vault as MP config will be kept in a cache, and will not be fetched from vault again until the expiration of that period. This property is ignored if secret-config-kv-path is not set. |
|
|||
Vault path in kv store, where all properties will be available as MP config. |
string |
|||
Used to hide confidential infos, for logging in particular. Possible values are: - low: display all secrets. medium: display only usernames and lease ids (ie: passwords and tokens are masked). high: hide lease ids and dynamic credentials username. |
|
|
||
Kv secret engine version. see https://www.vaultproject.io/docs/secrets/kv/index.html |
int |
|
||
Kv secret engine path. see https://www.vaultproject.io/docs/secrets/kv/index.html |
string |
|
||
Allows to bypass certificate validation on TLS communications. If true this will allow TLS communications with Vault, without checking the validity of the certificate presented by Vault. This is discouraged in production because it allows man in the middle type of attacks. |
boolean |
|
||
Certificate bundle used to validate TLS communications with Vault. The path to a pem bundle file, if TLS is required, and trusted certificates are not set through javax.net.ssl.trustStore system property. |
string |
|||
If true and Vault authentication type is kubernetes, TLS will be active and the cacert path will be set to /var/run/secrets/kubernetes.io/serviceaccount/ca.crt. If set, this setting will take precedence over property quarkus.vault.tls.ca-cert. This means that if Vault authentication type is kubernetes and we want to use quarkus.vault.tls.ca-cert or system property javax.net.ssl.trustStore, then this property should be set to false. |
boolean |
|
||
Timeout to establish a connection with Vault. |
|
|||
Request timeout on Vault. |
|
|||
Database credentials role, as defined by https://www.vaultproject.io/docs/secrets/databases/index.html One of database-credentials-role or kv-path needs to be defined. not both. |
string |
|||
A path in vault kv store, where we will find the kv-key. One of database-credentials-role or kv-path needs to be defined. not both. see https://www.vaultproject.io/docs/secrets/kv/index.html |
string |
|||
Key name to search in vault path kv-path. The value for that key is the credential. kv-key should not be defined if kv-path is not. see https://www.vaultproject.io/docs/secrets/kv/index.html |
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): |