Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
The handler name. Handler names are specified on handler classes using the |
string |
|||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Other unspecified properties to be passed to the JDBC driver when creating new connections. |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Enable DynamoDB service endpoint discovery. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront’s globally distributed edge locations. |
boolean |
|
||||||||||||||||||||||||||||
Enable doing a validation of the checksum of an object stored in S3. |
boolean |
|
||||||||||||||||||||||||||||
Enable using chunked encoding when signing the request payload for |
boolean |
|
||||||||||||||||||||||||||||
Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled. |
boolean |
|
||||||||||||||||||||||||||||
Enable using path style access for accessing S3 objects instead of DNS style access. DNS style access is preferred as it will result in better load balancing when accessing S3. |
boolean |
|
||||||||||||||||||||||||||||
Enable cross-region call to the region specified in the S3 resource ARN different than the region the client was configured with. If this flag is not set to 'true', the cross-region call will throw an exception. |
boolean |
|
||||||||||||||||||||||||||||
Define the profile name that should be consulted to determine the default value of |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type of the sync HTTP client implementation |
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given 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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
An Amazon Web Services region that hosts the given service. It overrides region provider chain with static value of region with which the service 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:
|
|
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
AWS Access key id |
string |
|||||||||||||||||||||||||||||
AWS Secret access key |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The name of the profile that should be used by this credentials provider.
If not specified, the value in |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 SSL Provider to be used in the Netty client.
Default is |
|
|||||||||||||||||||||||||||||
The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. |
long |
|
||||||||||||||||||||||||||||
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. |
int |
|
||||||||||||||||||||||||||||
Sets the period that the Netty client will send |
|
|||||||||||||||||||||||||||||
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. |
||||||||||||||||||||||||||||||
The hosts that the client is allowed to access without going through the proxy. |
list of string |
|||||||||||||||||||||||||||||
TLS managers provider type. Available providers:
|
|
|
||||||||||||||||||||||||||||
Path to the key store. |
path |
|||||||||||||||||||||||||||||
Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types. |
string |
|||||||||||||||||||||||||||||
Key store password |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present.
If you enable the health check, you must specify the |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not 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) |
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 |
||||||||||||||||||||||||||||
The schema registry key. e.g. to diff between different registry impls / instances as they have this registry url under different property key. Red Hat / Apicurio - apicurio.registry.url Confluent - schema.registry.url |
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 |
|||||||||||||||||||||||||||||
Store type |
string |
|||||||||||||||||||||||||||||
Store location |
string |
|||||||||||||||||||||||||||||
Store password |
string |
|||||||||||||||||||||||||||||
Store type |
string |
|||||||||||||||||||||||||||||
Store location |
string |
|||||||||||||||||||||||||||||
Store password |
string |
|||||||||||||||||||||||||||||
Store type |
string |
|||||||||||||||||||||||||||||
Store location |
string |
|||||||||||||||||||||||||||||
Store password |
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Configuration of the individual parsers. For example: quarkus.tika.parsers = pdf,odf quarkus.tika.parser-options.pdf.sort-by-position = true |
|
|||||||||||||||||||||||||||||
Full parser class name for a given parser abbreviation. For example: quarkus.tika.parsers = classparser quarkus.tika.parser.classparser = org.apache.tika.parser.asm.ClassParser |
|
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 an health check is published in case the smallrye-health extension is present |
boolean |
|
||||||||||||||||||||||||||||
Artemis connection url |
string |
required |
||||||||||||||||||||||||||||
Username for authentication, only used with JMS |
string |
|||||||||||||||||||||||||||||
Password for authentication, only used with JMS |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not the cache extension is enabled. If the extension is disabled, the caching annotations will have no effect at run time. |
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. |
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
If set to true, the application will attempt to look up the configuration from Consul |
boolean |
|
||||||||||||||||||||||||||||
Consul agent host |
host:port |
|
||||||||||||||||||||||||||||
Whether or not to use HTTPS when communicating with the agent |
boolean |
|
||||||||||||||||||||||||||||
Consul token to be provided when authentication is enabled |
string |
|||||||||||||||||||||||||||||
TrustStore to be used containing the SSL certificate used by Consul agent Can be either a classpath resource or a file system path |
path |
|||||||||||||||||||||||||||||
Password of TrustStore to be used containing the SSL certificate used by Consul agent |
string |
|||||||||||||||||||||||||||||
KeyStore to be used containing the SSL certificate for authentication with Consul agent 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 Consul agent |
string |
|||||||||||||||||||||||||||||
Password to recover key from KeyStore for SSL client authentication with Consul agent If no value is provided, the key-store-password will be used |
string |
|||||||||||||||||||||||||||||
When using HTTPS and no keyStore has been specified, whether or not to trust all certificates |
boolean |
|
||||||||||||||||||||||||||||
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 |
|
|||||||||||||||||||||||||||||
Common prefix that all keys share when looking up the keys from Consul. The prefix is not included in the keys of the user configuration |
string |
|||||||||||||||||||||||||||||
Keys whose value is a raw string. When this is used, the keys that end up in the user configuration are the keys specified her with '/' replaced by '.' |
list of string |
|||||||||||||||||||||||||||||
Keys whose value represents a properties file. When this is used, the keys that end up in the user configuration are the keys of the properties file, not these keys |
list of string |
|||||||||||||||||||||||||||||
If set to true, the application will not start if any of the configured config sources cannot be located |
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Path to the 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 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 |
|||||||||||||||||||||||||||||
Name of binary used to execute the docker commands. |
string |
|
||||||||||||||||||||||||||||
Build args passed to docker via |
|
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Environment variables to add to the container image |
|
|||||||||||||||||||||||||||||
Custom labels to add to the generated image |
|
|||||||||||||||||||||||||||||
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 |
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 |
|
||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The kind of database we will connect to (e.g. h2, postgresql…). |
string |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 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. |
|
|||||||||||||||||||||||||||||
Enable or disable native transport |
boolean |
|
||||||||||||||||||||||||||||
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. |
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
The HTTP console path. Various debug/development endpoints are deployed under this path. |
string |
|
||||||||||||||||||||||||||||
Enable the CORS filter. |
boolean |
|
||||||||||||||||||||||||||||
The HTTP port |
int |
|
||||||||||||||||||||||||||||
The HTTP port used to run tests |
int |
|
||||||||||||||||||||||||||||
The HTTP host |
string |
|
||||||||||||||||||||||||||||
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. 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 |
|||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
The access log pattern: If this is the string 'common', 'combined' or 'long' then this will use one of the specified named formats: - common: %h %l %u %t "%r" %s %b - combined: %h %l %u %t "%r" %s %b "%{i,Referer}" "%{i,User-Agent}" - long: %r %{ALL_REQUEST_HEADERS} 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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 over matches without methods set, otherwise the most restrictive permissions are applied. |
list of 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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an 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 |
|||||||||||||||||||||||||||||
The identifier which correlates to the provided user (also named "baseFilter") |
string |
|
||||||||||||||||||||||||||||
The dn where we look for users |
string |
required |
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 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 any migration 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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 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 any migration 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 |
|||||||||||||||||||||||||||||
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 name. Function names are specified on function classes using the |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Enable store_data_at_delete feature. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||
list of 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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Whether statistics collection is enabled. If 'metrics.enabled' is true, then the default here is considered true, otherwise the default is false. |
boolean |
|||||||||||||||||||||||||||||
Whether or not 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. |
string |
|||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. |
|
|||||||||||||||||||||||||||||
Whether Hibernate should quote all identifiers. |
boolean |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled |
boolean |
|
||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. |
boolean |
|
||||||||||||||||||||||||||||
Logs SQL bind parameter. Setting it to true is obviously not recommended in production. |
boolean |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||
list of 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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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. |
string |
|||||||||||||||||||||||||||||
Default precedence of null values in Valid values are: |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
The charset of the database. Used for DDL generation and also for the SQL import scripts. |
|
|||||||||||||||||||||||||||||
Whether Hibernate should quote all identifiers. |
boolean |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Format the SQL logs if SQL log is enabled |
boolean |
|
||||||||||||||||||||||||||||
Whether JDBC warnings should be collected and logged. |
boolean |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 strategy used for index lifecycle. |
|
|
||||||||||||||||||||||||||||
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:
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 |
|
||||||||||||||||||||||||||||
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 layout (e.g. index names, index aliases). |
class name |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers). |
class name |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
The class or the name of the bean used to configure layout (e.g. index names, index aliases). |
class name |
|||||||||||||||||||||||||||||
The class or the name of the bean used to configure full text analysis (e.g. analyzers, normalizers). |
class name |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Sets the trust store path |
string |
|||||||||||||||||||||||||||||
Sets the trust store password |
string |
|||||||||||||||||||||||||||||
Sets the trust store type |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Defines if the Jaeger extension is enabled. |
boolean |
|
||||||||||||||||||||||||||||
Whether or not 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 |
|
||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||
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 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 |
|
|
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
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 or not 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 |
|
||||||||||||||||||||||||||||
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 or not this service is cluster-local. Cluster local services are not exposed to the outside world. |
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 one 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 one 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 |
||||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||
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 repoistory 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 |
|
|||||||||||||||||||||||||||||
Wether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||
The secret name. |
string |
required |
||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
||||||||||||||||||||||||||||
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 or not 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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
If true, a Kubernetes Ingress will be created |
boolean |
|
||||||||||||||||||||||||||||
If true, the 'app.kubernetes.io/version' label will be part of the selectors of Service and Deployment |
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 |
|||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||
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 repoistory 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 |
|
|||||||||||||||||||||||||||||
Wether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
||||||||||||||||||||||||||||
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 or not 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 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 |
|
||||||||||||||||||||||||||||
If true, an OpenShift Route will be created |
boolean |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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. |
|
|
||||||||||||||||||||||||||||
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 repoistory 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 |
|
|||||||||||||||||||||||||||||
Wether the volumeName is read only or not. |
boolean |
|
||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||
string |
required |
|||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
Wether 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
|
|
|||||||||||||||||||||||||||||
Image pull policy. |
|
|
||||||||||||||||||||||||||||
The image pull secret |
list of string |
|||||||||||||||||||||||||||||
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 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 |
||||||||||||||||||||||||||||
The liveness probe This configuration section is optional |
Type |
Default |
||||||||||||||||||||||||||||
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 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 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 readiness probe This configuration section is optional |
Type |
Default |
||||||||||||||||||||||||||||
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 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 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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not 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 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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Determine whether to enable the Sentry logging extension. |
boolean |
|
||||||||||||||||||||||||||||
Sentry DSN The DSN is the first and most important thing to configure because it tells the SDK where to send events. You can find your project’s DSN in the “Client Keys” section of your “Project Settings” in Sentry. |
string |
|||||||||||||||||||||||||||||
The sentry log level. |
|
|||||||||||||||||||||||||||||
Sentry differentiates stack frames that are directly related to your application (“in application”) from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The difference is visible in the Sentry web interface where only the “in application” frames are displayed by default. You can configure which package prefixes your application uses with this option. This option is highly recommended as it affects stacktrace grouping and display on Sentry. See documentation: https://quarkus.io/guides/logging-sentry#in-app-packages |
list of string |
|||||||||||||||||||||||||||||
Environment With Sentry you can easily filter issues, releases, and user feedback by environment. The environment filter on sentry affects all issue-related metrics like count of users affected, times series graphs, and event count. By setting the environment option, an environment tag will be added to each new issue sent to Sentry. There are a few restrictions: → the environment name cannot contain newlines or spaces, cannot be the string “None” or exceed 64 characters. |
string |
|||||||||||||||||||||||||||||
Release A release is a version of your code that is deployed to an environment. When you give Sentry information about your releases, you unlock a number of new features: - Determine the issues and regressions introduced in a new release - Predict which commit caused an issue and who is likely responsible - Resolve issues by including the issue number in your commit message - Receive email notifications when your code gets deployed |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Microprofile Metrics support. Support for Microprofile metrics will be enabled if micrometer support is enabled and the MicroProfile Metrics dependency is present: <dependency> <groupId>org.eclipse.microprofile.metrics</groupId> <artifactId>microprofile-metrics-api</artifactId> </dependency> The micrometer extension currently provides a compatibility layer that supports the MP Metrics API, but metric names and recorded values will be different. Note that the MP Metrics compatibility layer will move to a different extension in the future. |
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 |
|||||||||||||||||||||||||||||
Micrometer JVM metrics support. Micrometer JVM metrics support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||
Micrometer System metrics support. Micrometer System metrics support is enabled by default. |
boolean |
|
||||||||||||||||||||||||||||
Support for export to Datadog
Support for Datadog will be enabled if micrometer support is enabled, the DatadogMeterRegistry is on the classpath and either this value is true, or this value is unset and |
boolean |
|||||||||||||||||||||||||||||
Support for export to JMX
Support for JMX will be enabled if micrometer support is enabled, the JmxMeterRegistry is on the classpath and either this value is true, or this value is unset and |
boolean |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Support for export to Stackdriver. <p> Support for Stackdriver will be enabled if micrometer support is enabled, the StackdriverMeterRegistry is on the classpath and either this value is true, or this value is unset and {@code quarkus.micrometer.registry-enabled-default} is true.
|
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 AzureMonitor.
Support for AzureMonitor will be enabled if micrometer support is enabled, the AzureMonitorMeterRegistry is on the classpath and either this value is true, or this value is unset and |
boolean |
|||||||||||||||||||||||||||||
The path for the azure monitor instrumentationKey |
string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Datadog MeterRegistry configuration <p> A property source for configuration of the Datadog MeterRegistry to push metrics using the Datadog API, see https://micrometer.io/docs/registry/datadog. Available values:
Other micrometer configuration attributes can also be specified. |
|
|||||||||||||||||||||||||||||
JMX registry configuration properties. <p> A property source for configuration of the JMX MeterRegistry, see https://micrometer.io/docs/registry/jmx. |
|
|||||||||||||||||||||||||||||
Prometheus registry configuration properties. <p> A property source for configuration of the Prometheus MeterRegistry, see https://micrometer.io/docs/registry/prometheus |
|
|||||||||||||||||||||||||||||
Azure Monitor registry configuration properties. <p> A property source for configuration of the AzureMonitor MeterRegistry, Available values:
Other micrometer configuration attributes can also be specified. |
|
|||||||||||||||||||||||||||||
Stackdriver registry configuration properties. <p> A property source for configuration of the Stackdriver MeterRegistry, see https://micrometer.io/docs/registry/stackdriver. Available values:
Other micrometer configuration attributes can also be specified. |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
Whether or not metrics are published in case a metrics 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 |
|
||||||||||||||||||||||||||||
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 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 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 preferences. Supported values are: |
string |
|||||||||||||||||||||||||||||
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 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 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 preferences. Supported values are: |
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: |
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: |
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 |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
The uri this driver should connect to. The driver supports bolt, bolt+routing or neo4j as schemes. |
string |
|
||||||||||||||||||||||||||||
If the driver should use encrypted traffic. |
boolean |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Configures which trust strategy to apply when using encrypted traffic. |
|
|
||||||||||||||||||||||||||||
The file of the certificate to use. |
path |
|||||||||||||||||||||||||||||
If hostname verification is used. |
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 |
|
||||||||||||||||||||||||||||
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 |
|
|
||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to 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 |
|||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the following properties must be configured: - 'authorization-path' and 'token-path' for the 'web-app' applications - 'jwks-path' or 'introspection-path' for both the 'web-app' and 'service' applications 'web-app' applications may also have 'user-info-path' and 'end-session-path' properties configured. |
boolean |
|
||||||||||||||||||||||||||||
Relative path 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 of the OIDC token endpoint which issues ID, access and refresh tokens. 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 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 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 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 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 |
|||||||||||||||||||||||||||||
The maximum amount of time the adapter will try connecting to the currently unavailable OIDC server for. For example, setting it to '20S' will let the adapter keep requesting the connection for up to 20 seconds. |
||||||||||||||||||||||||||||||
Public key for the local JWT token verification. OIDC server connection will not be created when this property is set. |
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". 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 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 |
|||||||||||||||||||||||||||||
Source of the principal roles. |
|
|||||||||||||||||||||||||||||
Expected issuer 'iss' claim value. |
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Token auto-refresh interval in seconds during the user re-authentication. If this option is set then the valid ID token will be refreshed if it will expire in less than a number of minutes set by this option. The user will still be authenticated if the ID token can no longer be refreshed but is still valid. This option 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 |
|||||||||||||||||||||||||||||
Client secret which is used for a 'client_secret_basic' authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive. |
string |
|||||||||||||||||||||||||||||
The client secret |
string |
|||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||
client_secret_jwt: JWT which includes client id as one of its claims is signed by the client secret and is submitted as a 'client_assertion' form parameter, while 'client_assertion_type' parameter is set to "urn:ietf:params:oauth:client-assertion-type:jwt-bearer". |
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 |
|||||||||||||||||||||||||||||
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. |
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. |
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Cookie path parameter value which, if set, will be used for the session, state and post logout cookies. It may need to be set when the redirect path has a root different to that of the original request URL. |
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 |
|
||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the authentication redirect URI. |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
|
||||||||||||||||||||||||||||
The base URL of the OpenID Connect (OIDC) server, for example, 'https://host:port/auth'. OIDC discovery endpoint will be called by default by appending a '.well-known/openid-configuration' path to 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 |
|||||||||||||||||||||||||||||
Enables OIDC discovery. If the discovery is disabled then the following properties must be configured: - 'authorization-path' and 'token-path' for the 'web-app' applications - 'jwks-path' or 'introspection-path' for both the 'web-app' and 'service' applications 'web-app' applications may also have 'user-info-path' and 'end-session-path' properties configured. |
boolean |
|
||||||||||||||||||||||||||||
Relative path 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 of the OIDC token endpoint which issues ID, access and refresh tokens. 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 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 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 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 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 |
|||||||||||||||||||||||||||||
The maximum amount of time the adapter will try connecting to the currently unavailable OIDC server for. For example, setting it to '20S' will let the adapter keep requesting the connection for up to 20 seconds. |
||||||||||||||||||||||||||||||
Public key for the local JWT token verification. OIDC server connection will not be created when this property is set. |
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". 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 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 |
|||||||||||||||||||||||||||||
Source of the principal roles. |
|
|||||||||||||||||||||||||||||
Expected issuer 'iss' claim value. |
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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Token auto-refresh interval in seconds during the user re-authentication. If this option is set then the valid ID token will be refreshed if it will expire in less than a number of minutes set by this option. The user will still be authenticated if the ID token can no longer be refreshed but is still valid. This option 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 |
|||||||||||||||||||||||||||||
Client secret which is used for a 'client_secret_basic' authentication method. Note that a 'client-secret.value' can be used instead but both properties are mutually exclusive. |
string |
|||||||||||||||||||||||||||||
The client secret |
string |
|||||||||||||||||||||||||||||
Authentication method. |
|
|||||||||||||||||||||||||||||
client_secret_jwt: JWT which includes client id as one of its claims is signed by the client secret and is submitted as a 'client_assertion' form parameter, while 'client_assertion_type' parameter is set to "urn:ietf:params:oauth:client-assertion-type:jwt-bearer". |
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 |
|||||||||||||||||||||||||||||
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. |
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. |
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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Additional properties which will be added as the query parameters to the authentication redirect URI. |
|
|||||||||||||||||||||||||||||
Cookie path parameter value which, if set, will be used for the session, state and post logout cookies. It may need to be set when the redirect path has a root different to that of the original request URL. |
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 |
|
||||||||||||||||||||||||||||
Certificate validation and hostname verification, which can be one of the following values from enum |
|
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Set this to false to use the |
boolean |
|
||||||||||||||||||||||||||||
Name of bean annotated with |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 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. |
list of Locale |
|
||||||||||||||||||||||||||||
Default locale 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. |
|
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 path of the banner (path relative to root of classpath) which could be provided by user |
string |
|
||||||||||||||||||||||||||||
Whether or not the banner will be displayed |
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 |
|||||||||||||||||||||||||||||
Paths of library to load. |
list of string |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Whether or not logging metrics are published in case a metrics extension is present. |
boolean |
|
||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||
Additional arguments to pass to the build process |
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 all security services should be added to the native image |
boolean |
|
||||||||||||||||||||||||||||
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 the native image server should be restarted |
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 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 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. 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 |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
A comma separated list of globs to match resource paths that should 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 |
|
||||||||||||||||||||||||||||
The requested output type. The default built in types are 'jar', 'fast-jar' (a prototype more performant version of the default 'jar' type), 'uber-jar' and 'native'. |
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 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 |
|||||||||||||||||||||||||||||
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 not 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 |
|
||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Duration to wait for the native image to built during testing |
|
|||||||||||||||||||||||||||||
The profile to use when testing the native image |
string |
|
||||||||||||||||||||||||||||
The profile to use when testing using @QuarkusTest |
string |
|
||||||||||||||||||||||||||||
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 greater 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. |
|
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
If console logging should be enabled |
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. |
|
|||||||||||||||||||||||||||||
If the console logging should be in color. If undefined quarkus takes best guess based on operating system and environment. 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). |
boolean |
|||||||||||||||||||||||||||||
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. 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 level for this category |
InheritableLevel |
|
||||||||||||||||||||||||||||
The names of the handlers to link to this category. |
list of string |
|||||||||||||||||||||||||||||
Specify whether or not this logger should send its output to its parent Logger |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
If console logging should be enabled |
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. |
|
|||||||||||||||||||||||||||||
If the console logging should be in color. If undefined quarkus takes best guess based on operating system and environment. 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). |
boolean |
|||||||||||||||||||||||||||||
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. 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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 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 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 or not 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 type of store to use.
When using the |
|
|
||||||||||||||||||||||||||||
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 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 |
|
||||||||||||||||||||||||||||
By default, the scheduler is not started unless a |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Class name for the configuration. |
string |
required |
||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The set of suffixes used when attempting to locate a template file. By default, |
list of string |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
The additional map of suffixes to content types. This map is used when working with template variants. By default, the |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
if set to true, access to all JAX-RS resources will be denied by default |
boolean |
|
||||||||||||||||||||||||||||
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") |
|
|||||||||||||||||||||||||||||
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. |
string |
|
||||||||||||||||||||||||||||
Whether or not detailed JAX-RS metrics should be enabled if the smallrye-metrics extension is present. See MicroProfile Metrics: Optional REST metrics. Deprecated. Use |
boolean |
|
||||||||||||||||||||||||||||
Ignore all explict JAX-RS |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Experimental: use one connection pool per thread. |
boolean |
|||||||||||||||||||||||||||||
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 without data written to or read from a connection before it is removed from the pool. |
|
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
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 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 or not to use slave nodes (only considered in Cluster mode). |
|
|
||||||||||||||||||||||||||||
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 much 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 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 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 or not to use slave nodes (only considered in Cluster mode). |
|
|
||||||||||||||||||||||||||||
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 much 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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The syntax used in CRON expressions. |
|
|
||||||||||||||||||||||||||||
If schedulers are enabled. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
List of security providers to enable for reflection |
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The rootPath under which queries will be served. Default to /graphql |
string |
|
||||||||||||||||||||||||||||
Enable metrics |
boolean |
|
||||||||||||||||||||||||||||
Change the type naming strategy. |
|
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
If GraphQL UI should be enabled. By default, GraphQL UI is enabled. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not extensions published health check should be enabled. |
boolean |
|
||||||||||||||||||||||||||||
Whether or not to include the Liveness and Readiness Health endpoints in the generated OpenAPI document |
boolean |
|
||||||||||||||||||||||||||||
Root path for health-checking endpoints. |
string |
|
||||||||||||||||||||||||||||
The relative path of the liveness health-checking endpoint. |
string |
|
||||||||||||||||||||||||||||
The relative path of the readiness health-checking endpoint. |
string |
|
||||||||||||||||||||||||||||
The relative path of the health group endpoint. |
string |
|
||||||||||||||||||||||||||||
The relative path of the wellness health-checking endpoint. |
string |
|
||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
If Health UI should be enabled. By default, Health UI is enabled. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The MP-JWT configuration object |
boolean |
|
||||||||||||||||||||||||||||
The name of the |
string |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The path to the metrics handler. |
string |
|
||||||||||||||||||||||||||||
Whether or not 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 or not 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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
Whether or not Reactive Messaging metrics are published in case a metrics extension is present (default to false). |
boolean |
|
||||||||||||||||||||||||||||
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 Swagger UI should be enabled. By default, Swagger UI is enabled. |
boolean |
|
||||||||||||||||||||||||||||
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 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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||
string |
||||||||||||||||||||||||||||||
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 |
|||||||||||||||||||||||||||||
Vault server url.
<p>
Example: https://localhost:8200
<p>
See also the documentation for the |
||||||||||||||||||||||||||||||
Renew grace period duration. <p> 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 is 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.
<p>
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 |
|
|||||||||||||||||||||||||||||
List of comma separated vault paths in kv store,
where all properties will be available as MP config properties as-is, with no prefix.
<p>
For instance, if vault contains property |
list of string |
|||||||||||||||||||||||||||||
Used to hide confidential infos, for logging in particular. Possible values are: <p> * 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. <p> see https://www.vaultproject.io/docs/secrets/kv/index.html |
int |
|
||||||||||||||||||||||||||||
KV secret engine path.
<p>
This value is used when building the url path in the KV secret engine programmatic access
(i.e. |
string |
|
||||||||||||||||||||||||||||
Timeout to establish a connection with Vault. |
|
|||||||||||||||||||||||||||||
Request timeout on Vault. |
|
|||||||||||||||||||||||||||||
List of comma separated vault paths in kv store,
where all properties will be available as prefixed MP config properties.
<p>
For instance if the application properties contains
|
|
|||||||||||||||||||||||||||||
Database credentials role, as defined by https://www.vaultproject.io/docs/secrets/databases/index.html One of |
string |
|||||||||||||||||||||||||||||
A path in vault kv store, where we will find the kv-key. One of |
string |
|||||||||||||||||||||||||||||
Key name to search in vault path
|
string |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not an health check is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
Specifies if being a standby should still return the active status code instead of the standby status code. |
boolean |
|
||||||||||||||||||||||||||||
Specifies if being a performance standby should still return the active status code instead of the performance standby status code. |
boolean |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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. Lease renewal does not apply. |
string |
|||||||||||||||||||||||||||||
Client token wrapped in a wrapping token, such as what is returned by: vault token create -wrap-ttl=60s -policy=myapp client-token and client-token-wrapping-token are exclusive. Lease renewal does not apply. |
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 |
|||||||||||||||||||||||||||||
Wrapping token containing a Secret Id, obtained from: vault write -wrap-ttl=60s -f auth/approle/role/myapp/secret-id secret-id and secret-id-wrapping-token are exclusive |
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 |
|||||||||||||||||||||||||||||
Wrapping token containing a Password, obtained from: vault kv get -wrap-ttl=60s secret/ The key has to be 'password', meaning the password has initially been provisioned with: vault kv put secret/ password= password and password-wrapping-token are exclusive |
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 |
|
||||||||||||||||||||||||||||
Allows configure Kubernetes authentication mount path. |
string |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
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 |
|
||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Specifies the name of the key to use. By default this will be the property key alias. Used when the same transit key is used with different configurations. Such as in:
|
string |
|||||||||||||||||||||||||||||
Set to true when the input is already hashed. Applies to sign operations. |
boolean |
|||||||||||||||||||||||||||||
When using a RSA key, specifies the RSA signature algorithm. Applies to sign operations. |
string |
|||||||||||||||||||||||||||||
Specifies the hash algorithm to use for supporting key types. Applies to sign operations. |
string |
|||||||||||||||||||||||||||||
Specifies the type of key to create for the encrypt operation. Applies to encrypt operations. |
string |
|||||||||||||||||||||||||||||
If enabled, the key will support convergent encryption, where the same plaintext creates the same ciphertext. Applies to encrypt operations. |
string |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
Whether or not a health check on gRPC status is published in case the smallrye-health extension is present. |
boolean |
|
||||||||||||||||||||||||||||
Whether or not 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 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 trust store which holds the certificate information of the certificates to trust |
path |
|||||||||||||||||||||||||||||
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 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 |
|||||||||||||||||||||||||||||
Type |
Default |
|||||||||||||||||||||||||||||
The gRPC Server port. |
int |
|
||||||||||||||||||||||||||||
The gRPC server host. |
string |
|
||||||||||||||||||||||||||||
The gRPC handshake timeout. |
||||||||||||||||||||||||||||||
The max inbound message size in bytes. |
int |
|||||||||||||||||||||||||||||
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 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 |
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 |
|
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): |